|
Oracle® Coherence Java API Reference Release 3.7.1.0 E22843-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.tangosol.util.Base
com.tangosol.util.processor.AbstractProcessor
com.tangosol.util.processor.PropertyProcessor
public abstract class PropertyProcessor
PropertyProcessor is a base class for EntryProcessor implementations that depend on a ValueManipulator.
Any concrete subclass would have to implement the methods of ExternalizableLite
interface calling the appropriate super class implementations first.
A typical concrete subclass would also implement the process()
method using the following pattern:
public Object process(InvocableMap.Entry entry) { // retrieve an old property value Object oOldValue = get(entry); ... // calculate a new value and the process result ... // based on the old value and the processor's attributes if (!oNewValue.equals(oOldValue)) { // set the new property value set(entry, oNewValue); } // return the process result return oResult; }
Field Summary | |
---|---|
protected ValueManipulator |
m_manipulator The property value manipulator. |
Constructor Summary | |
---|---|
PropertyProcessor() Default constructor (necessary for the ExternalizableLite interface). |
|
PropertyProcessor(java.lang.String sName) Construct a PropertyProcessor for the specified property name. |
|
PropertyProcessor(java.lang.String sName, boolean fUseIs) Construct a PropertyProcessor for the specified property name. |
|
PropertyProcessor(ValueManipulator manipulator) Construct a PropertyProcessor based for the specified ValueManipulator. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o) Compare the PropertyProcessor with another object to determine equality. |
protected java.lang.Object |
get(InvocableMap.Entry entry) Get the property value from the passed Entry object. |
protected abstract java.lang.String |
getDescription() Returns this PropertyProcessor's description. |
int |
hashCode() Determine a hash value for the PropertyProcessor object according to the general Object.hashCode() contract. |
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. |
protected void |
set(InvocableMap.Entry entry, java.lang.Object oValue) Set the property value into the passed Entry object. |
java.lang.String |
toString() Return a human-readable description for this PropertyProcessor. |
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.AbstractProcessor |
---|
processAll |
Methods inherited from interface com.tangosol.util.InvocableMap.EntryProcessor |
---|
process |
Field Detail |
---|
protected ValueManipulator m_manipulator
Constructor Detail |
---|
public PropertyProcessor()
public PropertyProcessor(java.lang.String sName)
This constructor assumes that the corresponding property getter will have a name of ("get" + sName) and the corresponding property setter's name will be ("set + sName).
sName
- a property namepublic PropertyProcessor(java.lang.String sName, boolean fUseIs)
This constructor assumes that the corresponding property getter will have a name of either ("get" + sName) or ("is + sName) and the corresponding property setter's name will be ("set + sName).
sName
- a property namefUseIs
- if true, the getter method will be prefixed with "is" rather than "get"public PropertyProcessor(ValueManipulator manipulator)
manipulator
- a ValueManipulator; could be nullMethod Detail |
---|
protected java.lang.Object get(InvocableMap.Entry entry)
entry
- the Entry objectValueExtractor.extract(java.lang.Object)
protected void set(InvocableMap.Entry entry, java.lang.Object oValue)
entry
- the Entry objectoValue
- a new property valueValueUpdater.update(java.lang.Object, java.lang.Object)
protected abstract java.lang.String getDescription()
public boolean equals(java.lang.Object o)
public int hashCode()
Object.hashCode()
contract.public java.lang.String toString()
public void readExternal(java.io.DataInput in) throws java.io.IOException
readExternal
in interface ExternalizableLite
in
- the DataInput stream to read data from in order to restore the state of this objectjava.io.IOException
- if an I/O exception occursjava.io.NotActiveException
- if the object is not in its initial state, and therefore cannot be deserialized intopublic void writeExternal(java.io.DataOutput out) throws java.io.IOException
writeExternal
in interface ExternalizableLite
out
- the DataOutput stream to write the state of this object tojava.io.IOException
- if an I/O exception occurspublic void readExternal(PofReader in) throws java.io.IOException
readExternal
in interface PortableObject
in
- the PofReader from which to read the object's statejava.io.IOException
- if an I/O error occurspublic void writeExternal(PofWriter out) throws java.io.IOException
writeExternal
in interface PortableObject
out
- the PofWriter to which to write the object's statejava.io.IOException
- if an I/O error occurs
|
Oracle® Coherence Java API Reference Release 3.7.1.0 E22843-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |