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, 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 Map	m_map Specifies the map of new values.

Constructor Summary

VersionedPutAll()
Default constructor (necessary for the ExternalizableLite interface).

VersionedPutAll(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(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(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.
Object	process(InvocableMap.Entry entry) Process a Map.Entry object.
void	readExternal(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.
String	toString() Return a human-readable description for this VersionedPutAll.
void	writeExternal(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.AbstractProcessor

processAll

Field Detail

m_map

protected 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(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(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 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

equals

public boolean equals(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 String toString()

Return a human-readable description for this VersionedPutAll.

Returns:

a String description of the VersionedPutAll

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

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

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

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

Parameters:

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

Throws:

IOException - if an I/O error occurs