Overview | Package | Class | Tree | Index | Help

Oracle® Coherence Java API Reference
v3.5.3
E15583-01
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.tangosol.util.processor
Class NumberIncrementor

    java.lang.Object
      com.tangosol.util.Base
          com.tangosol.util.processor.AbstractProcessor
              com.tangosol.util.processor.PropertyProcessor
                  com.tangosol.util.processor.NumberIncrementor

All Implemented Interfaces:
  ExternalizableLite, PortableObject, InvocableMap.EntryProcessor, java.io.Serializable

    public class NumberIncrementor

extends PropertyProcessor

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

Field Summary

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

Constructor Summary
`NumberIncrementor()` Default constructor (necessary for the ExternalizableLite interface).
`NumberIncrementor(java.lang.String sName, java.lang.Number 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.
`NumberIncrementor(ValueManipulator manipulator, java.lang.Number 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.

Method Summary
`protected java.lang.String` | `getDescription()` Returns this PropertyProcessor's description.
`java.lang.Object` | `process(InvocableMap.Entry entry)` Process a Map.Entry object.
`void` | `readExternal(java.io.DataInput in)` Restore the contents of this object by loading the object's state from the passed DataInput object.
`void` | `readExternal(PofReader in)` Restore the contents of a user type instance by reading its state using the specified PofReader object.
`void` | `writeExternal(java.io.DataOutput out)` Save the contents of this object by storing the object's state into the passed DataOutput object.
`void` | `writeExternal(PofWriter out)` Save the contents of a POF user type instance by writing its state using the specified PofWriter 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`

Constructor Detail

### NumberIncrementor

    public NumberIncrementor()

  Default constructor (necessary for the ExternalizableLite interface).

### NumberIncrementor

    public NumberIncrementor(java.lang.String sName,
                             java.lang.Number 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
    `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,
                             java.lang.Number 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
    `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 Detail

### process

    public java.lang.Object process(InvocableMap.Entry entry)

  Process a Map.Entry object.

  Parameters:
    `entry` - the Entry to process
  Returns:
    the result of the processing, if any

### getDescription

    protected java.lang.String getDescription()

  Returns this PropertyProcessor's description.

  Specified by:
    `getDescription` in class `PropertyProcessor`
  Returns:
    this PropertyProcessor's description

### readExternal

    public void readExternal(java.io.DataInput in)
                      throws java.io.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`
  Parameters:
    `in` - the DataInput stream to read data from in order to restore the state of this object
  Throws:
    `java.io.IOException` - if an I/O exception occurs
    `java.io.NotActiveException` - if the object is not in its initial state, and therefore cannot be deserialized into

### writeExternal

    public void writeExternal(java.io.DataOutput out)
                       throws java.io.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`
  Parameters:
    `out` - the DataOutput stream to write the state of this object to
  Throws:
    `java.io.IOException` - if an I/O exception occurs

### readExternal

    public void readExternal(PofReader in)
                      throws java.io.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`
  Parameters:
    `in` - the PofReader from which to read the object's state
  Throws:
    `java.io.IOException` - if an I/O error occurs

### writeExternal

    public void writeExternal(PofWriter out)
                       throws java.io.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`
  Parameters:
    `out` - the PofWriter to which to write the object's state
  Throws:
    `java.io.IOException` - if an I/O error occurs

Overview | Package | Class | Tree | Index | Help

Oracle® Coherence Java API Reference
v3.5.3
E15583-01
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000, 2010, Oracle. All rights reserved.