Package com.tangosol.util.processor

Class NumberMultiplier<K,V,N extends Number>

java.lang.Object

com.tangosol.util.Base

com.tangosol.util.processor.AbstractProcessor<K,V,R>

com.tangosol.util.processor.PropertyProcessor<K,V,N>

com.tangosol.util.processor.NumberMultiplier<K,V,N>

All Implemented Interfaces:

ExternalizableLite, PortableObject, InvocableMap.EntryProcessor<K,V,N>, Serializable

public class NumberMultiplier<K,V,N extends Number>
extends PropertyProcessor<K,V,N>

The NumberMultiplier entry processor is used to multiply a property value of a Number type. Supported types are: Byte, Short, Integer, Long, Float, Double, BigInteger and BigDecimal.

Since:

Coherence 3.1

Author:

gg 2005.10.31

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.tangosol.util.Base

Base.LoggingWriter

Field Summary

Fields inherited from class com.tangosol.util.processor.PropertyProcessor

m_manipulator

Fields inherited from class com.tangosol.util.Base

LOG_ALWAYS, LOG_CONFIG, LOG_DEBUG, LOG_ERR, LOG_INFO, LOG_MAX, LOG_MIN, LOG_QUIET, LOG_WARN, POWER_0, POWER_G, POWER_K, POWER_M, POWER_T, UNIT_D, UNIT_H, UNIT_M, UNIT_MS, UNIT_NS, UNIT_S, UNIT_US

Constructor Summary

Constructors

Constructor	Description
NumberMultiplier()	Default constructor (necessary for the ExternalizableLite interface).
NumberMultiplier(ValueManipulator<V,N> manipulator, N numFactor, boolean fPostFactor)	Construct an NumberMultiplier processor that will multiply a property value by a specified factor, returning either the old or the new value as specified.
NumberMultiplier(String sName, N numFactor, boolean fPostFactor)	Construct an NumberMultiplier processor that will multiply a property value by a specified factor, returning either the old or the new value as specified.

Method Summary

Modifier and Type	Method	Description
protected String	getDescription()	Returns this PropertyProcessor's description.
N	getNumFactor()	Returns the number to multiply by.
boolean	getPostFactor()	Returns whether to return the value before it was multiplied.
N	process(InvocableMap.Entry<K,V> entry)	Process a Map.Entry object.
void	readExternal(PofReader in)	Restore the contents of a user type instance by reading its state using the specified PofReader object.
void	readExternal(DataInput in)	Restore the contents of this object by loading the object's state from the passed DataInput object.
void	writeExternal(PofWriter out)	Save the contents of a POF user type instance by writing its state using the specified PofWriter object.
void	writeExternal(DataOutput out)	Save the contents of this object by storing the object's state into the passed DataOutput object.

Methods inherited from class com.tangosol.util.processor.PropertyProcessor

equals, get, hashCode, set, toString

Methods inherited from class com.tangosol.util.processor.AbstractProcessor

processAll

Methods inherited from class com.tangosol.util.Base

azzert, azzert, azzert, azzertFailed, breakLines, breakLines, capitalize, checkNotEmpty, checkNotNull, checkRange, computeSafeWaitTime, decimalValue, dup, dup, ensureBigDecimal, ensureClassLoader, ensureRuntimeException, ensureRuntimeException, equals, equalsDeep, err, err, err, err, err, escape, formatDateTime, getCallerStackFrame, getCommonMonitor, getCommonMonitor, getCommonMonitor, getContextClassLoader, getContextClassLoader, getDeepMessage, getErr, getLastSafeTimeMillis, getLog, getMaxDecDigits, getMaxHexDigits, getOriginalException, getOut, getProcessRandom, getRandom, getRandomBinary, getRandomBinary, getRandomString, getSafeTimeMillis, getStackFrame, getStackFrames, getStackTrace, getStackTrace, getStackTrace, getThreadFactory, getTimeZone, getUpTimeMillis, hashCode, hexValue, indentString, indentString, isDecimal, isHex, isLogEcho, isOctal, log, log, log, log, log, makeInteger, makeLong, makeThread, mergeArray, mergeBooleanArray, mergeByteArray, mergeCharArray, mergeDoubleArray, mergeFloatArray, mergeIntArray, mergeLongArray, mod, mod, octalValue, out, out, out, out, out, pad, parseBandwidth, parseBandwidth, parseDelimitedString, parseHex, parseHex, parseMemorySize, parseMemorySize, parsePercentage, parseTime, parseTime, parseTimeNanos, parseTimeNanos, printStackTrace, randomize, randomize, randomize, randomize, read, read, read, read, read, read, read, replace, setErr, setLog, setLogEcho, setOut, sleep, toBandwidthString, toBandwidthString, toCharEscape, toCrc, toCrc, toCrc, toCrc, toCrc, toDecString, toDelimitedString, toDelimitedString, toDelimitedString, toDelimitedString, toHex, toHex, toHexDump, toHexEscape, toHexEscape, toHexEscape, toHexEscape, toHexString, toMemorySizeString, toMemorySizeString, toQuotedCharEscape, toQuotedStringEscape, toSqlString, toString, toString, toStringEscape, toUnicodeEscape, trace, trace, trace, trace, trace, trace, trace, trace, trace, truncateString, truncateString, wait

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NumberMultiplier

public NumberMultiplier()

Default constructor (necessary for the ExternalizableLite interface).

NumberMultiplier

public NumberMultiplier(String sName,
                        N numFactor,
                        boolean fPostFactor)

Construct an NumberMultiplier processor that will multiply a property value by a specified factor, returning either the old or the new value as specified. The Java type of the original property value will dictate the way the specified factor is interpreted. For example, applying a factor of Double(0.5) to a property value of Integer(4) will result in a new property value of Integer(2).
If the original property value is null, the Java type of the numFactor parameter will dictate the Java type of the new value.

Parameters:

sName - the property name or null if the target object is an instance of a Number

numFactor - the Number representing the magnitude and sign of the multiplier

fPostFactor - pass true to return the value as it was before it was multiplied, or pass false to return the value as it is after it is multiplied

NumberMultiplier

public NumberMultiplier(ValueManipulator<V,N> manipulator,
                        N numFactor,
                        boolean fPostFactor)

Construct an NumberMultiplier processor that will multiply a property value by a specified factor, returning either the old or the new value as specified. The Java type of the original property value will dictate the way the specified factor is interpreted. For example, applying a factor of Double(0.5) to a property value of Integer(4) will result in a new property value of Integer(2).
If the original property value is null, the Java type of the numFactor parameter will dictate the Java type of the new value.

Parameters:

manipulator - the ValueManipulator; could be null if the target object is an instance of a Number

numFactor - the Number representing the magnitude and sign of the multiplier

fPostFactor - pass true to return the value as it was before it was multiplied, or pass false to return the value as it is after it is multiplied

Method Detail

process

public N process(InvocableMap.Entry<K,V> entry)

Process a Map.Entry object.

Note: if this method throws an exception, all modifications to the supplied entry or any other entries retrieved via the BackingMapContext.getBackingMapEntry(java.lang.Object) API will be rolled back leaving all underlying values unchanged.

Parameters:

entry - the Entry to process

Returns:

the result of the processing, if any

getDescription

protected String getDescription()

Returns this PropertyProcessor's description.

Specified by:

getDescription in class PropertyProcessor<K,V,N extends Number>

Returns:

this PropertyProcessor's description

readExternal

public void readExternal(DataInput in)
                  throws IOException

Restore the contents of this object by loading the object's state from the passed DataInput object.

Specified by:

readExternal in interface ExternalizableLite

Overrides:

readExternal in class PropertyProcessor<K,V,N extends Number>

Parameters:

in - the DataInput stream to read data from in order to restore the state of this object

Throws:

IOException - if an I/O exception occurs

NotActiveException - if the object is not in its initial state, and therefore cannot be deserialized into

writeExternal

public void writeExternal(DataOutput out)
                   throws IOException

Save the contents of this object by storing the object's state into the passed DataOutput object.

Specified by:

writeExternal in interface ExternalizableLite

Overrides:

writeExternal in class PropertyProcessor<K,V,N extends Number>

Parameters:

out - the DataOutput stream to write the state of this object to

Throws:

IOException - if an I/O exception occurs

readExternal

public void readExternal(PofReader in)
                  throws IOException

Restore the contents of a user type instance by reading its state using the specified PofReader object.

Specified by:

readExternal in interface PortableObject

Overrides:

readExternal in class PropertyProcessor<K,V,N extends Number>

Parameters:

in - the PofReader from which to read the object's state

Throws:

IOException - if an I/O error occurs

writeExternal

public void writeExternal(PofWriter out)
                   throws IOException

Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Specified by:

writeExternal in interface PortableObject

Overrides:

writeExternal in class PropertyProcessor<K,V,N extends Number>

Parameters:

out - the PofWriter to which to write the object's state

Throws:

IOException - if an I/O error occurs

getNumFactor

public N getNumFactor()

Returns the number to multiply by.

Returns:

the number to multiply by

getPostFactor

public boolean getPostFactor()

Returns whether to return the value before it was multiplied.

Returns:

whether to return the value before it was multiplied