com.tangosol.util.processor
Class VersionedPut

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

All Implemented Interfaces:

ExternalizableLite, PortableObject, InvocableMap.EntryProcessor, Serializable

public class VersionedPut
extends AbstractProcessor
implements ExternalizableLite, PortableObject

VersionedPut is an EntryProcessor that assumes that entry values implement Versionable interface and performs an Entry.setValue operation if and only if the version of the specified value matches to the version of the current value. In case of the match, the VersionedPut will increment the version indicator before the value is updated.

Since:

Coherence 3.2

Author:

gg 2006.05.07; Acknowledgments: Simon Bisson

See Also:

ConditionalPut

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 Versionable	m_oValue Specifies the new value to update an entry with.

Constructor Summary

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

VersionedPut(Versionable oValue)
Construct a VersionedPut 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).

VersionedPut(Versionable oValue, boolean fAllowInsert, boolean fReturn)
Construct a VersionedPut 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.

Method Summary

boolean	equals(Object o) Compare the VersionedPut with another object to determine equality.
int	hashCode() Determine a hash value for the VersionedPut 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 VersionedPut.
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_oValue

protected Versionable m_oValue

Specifies the new value to update an entry with.

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

VersionedPut

public VersionedPut()

Default constructor (necessary for the ExternalizableLite interface).

VersionedPut

public VersionedPut(Versionable oValue)

Construct a VersionedPut 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:

oValue - a Versionable value to update an entry with

VersionedPut

public VersionedPut(Versionable oValue,
                    boolean fAllowInsert,
                    boolean fReturn)

Construct a VersionedPut 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. This processor optionally returns the current value as a result of the invocation if it has not been updated (the versions did not match).

Parameters:

oValue - a value to update an entry 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 current value in case it has 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 VersionedPut with another object to determine equality.

Returns:

true iff this VersionedPut and the passed object are equivalent VersionedPut

hashCode

public int hashCode()

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

Returns:

an integer hash value for this VersionedPut object

toString

public String toString()

Return a human-readable description for this VersionedPut.

Returns:

a String description of the VersionedPut

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