|
Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-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.comparator.SafeComparator
public class SafeComparator
Null-safe delegating comparator. Null values are evaluated as "less then" any non-null value. If the wrapped comparator is not specified then all non-null values must implement the Comparable
interface. <p/> Use SafeComparator.INSTANCE to obtain an instance of non-delegating SafeComparator.
Field Summary | |
---|---|
static SafeComparator |
INSTANCE The trivial SafeComparator. |
protected Comparator |
m_comparator The wrapped Comparator. |
Constructor Summary | |
---|---|
SafeComparator() Default constructor (for ExternalizableLite and PortableObject). |
|
SafeComparator(Comparator comparator) Construct a SafeComparator delegating to the specified (wrapped) comparator. |
Method Summary | |
---|---|
int |
compare(Object o1, Object o2) Compares its two arguments for order. |
int |
compareEntries(QueryMap.Entry entry1, QueryMap.Entry entry2) Compare two entries using the underlying comparator. |
static int |
compareSafe(Comparator comparator, Object o1, Object o2) Compares its two arguments for order. |
boolean |
equals(Object o) Determine if two comparators are equal. |
Comparator |
getComparator() Obtain the wrapped Comparator. |
int |
hashCode() Return the hash code for this comparator. |
boolean |
isKeyComparator() Specifies whether this comparator expects to compare keys or values. |
static boolean |
isKeyComparator(Comparator comparator) Check whether the specified comparator expects to compare keys or values. |
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 Comparator. |
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. |
Field Detail |
---|
public static final SafeComparator INSTANCE
protected Comparator m_comparator
Constructor Detail |
---|
public SafeComparator()
public SafeComparator(Comparator comparator)
comparator
- Comparator object to delegate comparison of non-null values (optional)Method Detail |
---|
public int compare(Object o1, Object o2)
Comparable
interface.compare
in interface Comparator
o1
- the first object to be comparedo2
- the second object to be comparedClassCastException
- if the arguments' types prevent them from being compared by this Comparator.public int compareEntries(QueryMap.Entry entry1, QueryMap.Entry entry2)
compareEntries
in interface QueryMapComparator
entry1
- the first entry to compare values from; read-onlyentry2
- the second entry to compare values from; read-onlypublic boolean isKeyComparator()
isKeyComparator
in interface EntryAwareComparator
public static boolean isKeyComparator(Comparator comparator)
comparator
- a Comparator to checkpublic Comparator getComparator()
public static int compareSafe(Comparator comparator, Object o1, Object o2)
Comparable
interface.comparator
- a comparator to use for the comparison (optional)o1
- the first object to be comparedo2
- the second object to be comparedClassCastException
- if the arguments are not Comparablepublic String toString()
public boolean equals(Object o)
equals
in interface Comparator
o
- the other comparatorObject.equals(java.lang.Object)
, Object.hashCode()
public int hashCode()
public void readExternal(DataInput in) throws IOException
readExternal
in interface ExternalizableLite
in
- the DataInput stream to read data from in order to restore the state of this objectIOException
- if an I/O exception occursNotActiveException
- if the object is not in its initial state, and therefore cannot be deserialized intopublic void writeExternal(DataOutput out) throws IOException
writeExternal
in interface ExternalizableLite
out
- the DataOutput stream to write the state of this object toIOException
- if an I/O exception occurspublic void readExternal(PofReader in) throws IOException
readExternal
in interface PortableObject
in
- the PofReader from which to read the object's stateIOException
- if an I/O error occurspublic void writeExternal(PofWriter out) throws IOException
writeExternal
in interface PortableObject
out
- the PofWriter to which to write the object's stateIOException
- if an I/O error occurs
|
Oracle® Coherence Java API Reference Release 3.6.0.0 E15725-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |