Package com.tangosol.util.processor

Class NumberIncrementor<K,V,N extends Number>

java.lang.Object
com.tangosol.util.Base
com.tangosol.util.processor.AbstractProcessor<K,V,N>
com.tangosol.util.processor.PropertyProcessor<K,V,N>
com.tangosol.util.processor.NumberIncrementor<K,V,N>
All Implemented Interfaces:
ExternalizableLite, PortableObject, InvocableMap.EntryProcessor<K,V,N>, Serializable
public class NumberIncrementor<K,V,N extends Number> extends PropertyProcessor<K,V,N>
The NumberIncrementor entry processor is used to increment 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:

  • Constructor Details

    • NumberIncrementor

      public NumberIncrementor()
      Default constructor (necessary for the ExternalizableLite interface).

    • NumberIncrementor

      public NumberIncrementor(String sName, N numInc, boolean fPostIncrement)
      Construct an NumberIncrementor processor that will increment a property value by a specified amount, returning either the old or the new value as specified. The Java type of the numInc parameter will dictate the Java type of the original and the new value.
      Parameters:
      sName - the property name or null if the target object is an instance of a Number)
      numInc - the Number representing the magnitude and sign of the increment
      fPostIncrement - pass true to return the value as it was before it was incremented, or pass false to return the value as it is after it is incremented

    • NumberIncrementor

      public NumberIncrementor(ValueManipulator manipulator, N numInc, boolean fPostIncrement)
      Construct an NumberIncrementor processor that will increment a property value by a specified amount, returning either the old or the new value as specified. The Java type of the numInc parameter will dictate the Java type of the original and the new value.
      Parameters:
      manipulator - the ValueManipulator; could be null if the target object is an instance of a Number
      numInc - the Number representing the magnitude and sign of the increment
      fPostIncrement - pass true to return the value as it was before it was incremented, or pass false to return the value as it is after it is incremented

  • Method Details

    • 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

    • getNumInc

      public N getNumInc()
      Returns the number to increment by.
      Returns:
      the number to increment by

    • getPostInc

      public boolean getPostInc()
      Returns Whether to return the value before it was incremented ("post-increment") or after it is incremented ("pre-increment").
      Returns:
      whether to return the value before it was incremented

    • 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

    • 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