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 VersionedPutAll

    java.lang.Object
      com.tangosol.util.Base
          com.tangosol.util.processor.AbstractProcessor
              com.tangosol.util.processor.VersionedPutAll

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

    public class VersionedPutAll

extends AbstractProcessor
implements ExternalizableLite, PortableObject

VersionedPutAll is an EntryProcessor that assumes that entry values implement `Versionable` interface and performs an `Entry.setValue` operation only for entries whose versions match to versions of the corresponding current values. In case of the match, the VersionedPutAll will increment the version indicator before each value is updated.

Since:
  Coherence 3.2
Author:
  gg 2006.05.07
See Also:
  `VersionedPut`

Field Summary
`protected boolean` | `m_fInsert` Specifies whether or not an insert is allowed.
`protected boolean` | `m_fReturn` Specifies whether or not a return value is required.
`protected java.util.Map` | `m_map` Specifies the map of new values.

Constructor Summary
`VersionedPutAll()` Default constructor (necessary for the ExternalizableLite interface).
`VersionedPutAll(java.util.Map map)` Construct a VersionedPutAll processor that updates an entry with a new value if and only if the version of the new value matches to the version of the current entry's value (which must exist).
`VersionedPutAll(java.util.Map map, boolean fAllowInsert, boolean fReturn)` Construct a VersionedPutAll processor that updates an entry with a new value if and only if the version of the new value matches to the version of the current entry's value (which must exist).

Method Summary
`boolean` | `equals(java.lang.Object o)` Compare the VersionedPutAll with another object to determine equality.
`int` | `hashCode()` Determine a hash value for the VersionedPutAll object according to the general `Object.hashCode()` contract.
`java.lang.Object` | `process(InvocableMap.Entry entry)` Process a Map.Entry object.
`java.util.Map` | `processAll(java.util.Set setEntries)` Process a Set of InvocableMap.Entry objects. This method is semantically equivalent to:
       Map mapResults = new ListMap();
       for (Iterator iter = setEntries.iterator(); iter.hasNext(); )
           {
           Entry entry = (Entry) iter.next();
           mapResults.put(entry.getKey(), process(entry));
           }
       return mapResults;
`protected java.lang.Object` | `processEntry(InvocableMap.Entry entry, java.util.Map mapAll, boolean fInsert, boolean fReturn)` Process the given entry.
`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.
`java.lang.String` | `toString()` Return a human-readable description for this VersionedPutAll.
`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.

Field Detail

### m_map

    protected java.util.Map m_map

  Specifies the map of new values.

### m_fInsert

    protected boolean m_fInsert

  Specifies whether or not an insert is allowed.

### m_fReturn

    protected boolean m_fReturn

  Specifies whether or not a return value is required.

Constructor Detail

### VersionedPutAll

    public VersionedPutAll()

  Default constructor (necessary for the ExternalizableLite interface).

### VersionedPutAll

    public VersionedPutAll(java.util.Map map)

  Construct a VersionedPutAll processor that updates an entry with a new value if and only if the version of the new value matches to the version of the current entry's value (which must exist). The result of the `process(com.tangosol.util.InvocableMap.Entry)` invocation does not return any result.

  Parameters:
    `map` - a map of values to update entries with

### VersionedPutAll

    public VersionedPutAll(java.util.Map map,
                           boolean fAllowInsert,
                           boolean fReturn)

  Construct a VersionedPutAll processor that updates an entry with a new value if and only if the version of the new value matches to the version of the current entry's value (which must exist). This processor optionally returns a map of entries that have not been updated (the versions did not match).

  Parameters:
    `map` - a map of values to update entries with
    `fAllowInsert` - specifies whether or not an insert should be allowed (no currently existing value)
    `fReturn` - specifies whether or not the processor should return the entries that have not been updated

Method Detail

### process

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

  Process a Map.Entry object.

  Specified by:
    `process` in interface `InvocableMap.EntryProcessor`
  Parameters:
    `entry` - the Entry to process
  Returns:
    the result of the processing, if any

### processAll

    public java.util.Map processAll(java.util.Set setEntries)

  Process a Set of InvocableMap.Entry objects. This method is semantically equivalent to:

         Map mapResults = new ListMap();
         for (Iterator iter = setEntries.iterator(); iter.hasNext(); )
             {
             Entry entry = (Entry) iter.next();
             mapResults.put(entry.getKey(), process(entry));
             }
         return mapResults;

  Specified by:
    `processAll` in interface `InvocableMap.EntryProcessor`
  Overrides:
    `processAll` in class `AbstractProcessor`
  Parameters:
    `setEntries` - a read-only Set of InvocableMap.Entry objects to process
  Returns:
    a Map containing the results of the processing, up to one entry for each InvocableMap.Entry that was processed, keyed by the keys of the Map that were processed, with a corresponding value being the result of the processing for each key

### equals

    public boolean equals(java.lang.Object o)

  Compare the VersionedPutAll with another object to determine equality.

  Returns:
    true iff this VersionedPutAll and the passed object are equivalent VersionedPutAll

### hashCode

    public int hashCode()

  Determine a hash value for the VersionedPutAll object according to the general `Object.hashCode()` contract.

  Returns:
    an integer hash value for this VersionedPutAll object

### toString

    public java.lang.String toString()

  Return a human-readable description for this VersionedPutAll.

  Returns:
    a String description of the VersionedPutAll

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

### processEntry

    protected java.lang.Object processEntry(InvocableMap.Entry entry,
                                            java.util.Map mapAll,
                                            boolean fInsert,
                                            boolean fReturn)

  Process the given entry.

  Parameters:
    `entry` - entry the entry to be processed
    `mapAll` - the map of new values
    `fInsert` - specifies whether or not an insert is allowed
    `fReturn` - specifies whether or not a return value is required
  Returns:
    the result of processing the entry; can be NO_RESULT

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.