CollationMatchKey (saxon JavaDoc)

java.lang.Object
- net.sf.saxon.expr.sort.CollationMatchKey

All Implemented Interfaces:

Comparable, AtomicMatchKey
```
public class CollationMatchKey
extends Object
implements AtomicMatchKey, Comparable
```
A match key for comparing strings under a collation. Wraps a Java CollationKey obtained from the collation.

Field Summary
- Fields inherited from interface net.sf.saxon.expr.sort.AtomicMatchKey
  NaN_MATCH_KEY

Constructor Summary

Constructors
Constructor Description

CollationMatchKey(CollationKey key)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AtomicValue`	`asAtomic()`	Get an atomic value that encapsulates this match key.
`int`	`compareTo(Object o)`
`boolean`	`equals(Object o)`
`int`	`hashCode()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CollationMatchKey
```
public CollationMatchKey(CollationKey key)
```
- Method Detail
  - compareTo
```
public int compareTo(Object o)
```
    Specified by:
    
    compareTo in interface Comparable
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - asAtomic
```
public AtomicValue asAtomic()
```
    Get an atomic value that encapsulates this match key. Needed to support the collation-key() function.
    
    Specified by:
    
    asAtomic in interface AtomicMatchKey
    
    Returns:
    
    an atomic value that encapsulates this match key