Collapse All Expand All

C#

Oracle® Coherence .NET API Reference
IQueryCacheComparer..::.CompareEntries Method
IQueryCacheComparer Interface See Also Send Feedback

Oracle® Coherence .NET API Reference Release 3.6
E15727-01
Compare two entries based on the rules specified by IComparer.

Namespace: Tangosol.Util.Comparator
Assembly: Coherence (in Coherence.dll) Version: 3.6.0.0 (3.6.0.0)

# Syntax

C#
    int CompareEntries(
    	IQueryCacheEntry entry1,
    	IQueryCacheEntry entry2
    )

#### Parameters

entry1
  Type: Tangosol.Net.Cache..::.IQueryCacheEntry
  The first entry to compare values from; read-only.

entry2
  Type: Tangosol.Net.Cache..::.IQueryCacheEntry
  The second entry to compare values from; read-only.

#### Return Value

A negative integer, zero, or a positive integer as the first entry denotes a value that is is less than, equal to, or greater than the value denoted by the second entry.

# Remarks

If possible, use the Extract(IValueExtractor) method to optimize the value extraction process.

This method is expected to be implemented by IComparer wrappers, which simply pass on this invocation to the wrapped IComparer objects if they too implement this interface, or to invoke their default compare method passing the actual objects (not the extracted values) obtained from the extractor using the passed entries.

This interface is also expected to be implemented by IValueExtractor implementations that implement the IComparer interface. It is expected that in most cases, the IComparer wrappers will eventually terminate at (i.e. delegate to) IValueExtractors that also implement this interface.

# Exceptions

Exception | Condition
--- | ---
System..::.InvalidCastException | If the arguments' types prevent them from being compared by this IComparer.
System..::.ArgumentException | If the extractor cannot handle the passed objects for any other reason; an implementor should include a descriptive message.

# See Also

IQueryCacheComparer Interface
Tangosol.Util.Comparator Namespace