Package net.sf.saxon.expr.sort
Class CodepointCollator
java.lang.Object
net.sf.saxon.expr.sort.CodepointCollator
- All Implemented Interfaces:
Serializable
,StringCollator
,SubstringMatcher
public class CodepointCollator
extends Object
implements StringCollator, SubstringMatcher, Serializable
A collating sequence that uses Unicode codepoint ordering
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Compare two CharSequence objects.boolean
comparesEqual
(String s1, String s2) Test whether one string is equal to another, according to the rules of the XPath compare() function.int
compareStrings
(String a, String b) Compare two string objects.boolean
Test whether one string contains another, according to the rules of the XPath contains() functionboolean
Test whether one string ends with another, according to the rules of the XPath ends-with() functionGet a collation key for two Strings.static CodepointCollator
boolean
startsWith
(String s1, String s2) Test whether one string starts with another, according to the rules of the XPath starts-with() functionsubstringAfter
(String s1, String s2) Return the part of a string after a given substring, according to the rules of the XPath substring-after() functionsubstringBefore
(String s1, String s2) Return the part of a string before a given substring, according to the rules of the XPath substring-before() function
-
Constructor Details
-
CodepointCollator
public CodepointCollator()
-
-
Method Details
-
getInstance
-
compareStrings
Compare two string objects.- Specified by:
compareStrings
in interfaceStringCollator
- Parameters:
a
- the first stringb
- the second string- Returns:
- <0 if a<b, 0 if a=b, >0 if a>b
- Throws:
ClassCastException
- if the objects are of the wrong type for this Comparer
-
compareCS
Compare two CharSequence objects. This is hand-coded to avoid converting the objects into Strings.- Returns:
- <0 if a<b, 0 if a=b, >0 if a>b
- Throws:
ClassCastException
- if the objects are of the wrong type for this Comparer
-
comparesEqual
Test whether one string is equal to another, according to the rules of the XPath compare() function. The result is true if and only if the compare() method returns zero: but the implementation may be more efficient than calling compare and testing the result for zero- Specified by:
comparesEqual
in interfaceStringCollator
- Parameters:
s1
- the first strings2
- the second string- Returns:
- true iff s1 equals s2
-
contains
Test whether one string contains another, according to the rules of the XPath contains() function- Specified by:
contains
in interfaceSubstringMatcher
- Parameters:
s1
- the containing strings2
- the contained string- Returns:
- true iff s1 contains s2
-
endsWith
Test whether one string ends with another, according to the rules of the XPath ends-with() function- Specified by:
endsWith
in interfaceSubstringMatcher
- Parameters:
s1
- the containing strings2
- the contained string- Returns:
- true iff s1 ends with s2
-
startsWith
Test whether one string starts with another, according to the rules of the XPath starts-with() function- Specified by:
startsWith
in interfaceSubstringMatcher
- Parameters:
s1
- the containing strings2
- the contained string- Returns:
- true iff s1 starts with s2
-
substringAfter
Return the part of a string after a given substring, according to the rules of the XPath substring-after() function- Specified by:
substringAfter
in interfaceSubstringMatcher
- Parameters:
s1
- the containing strings2
- the contained string- Returns:
- the part of s1 that follows the first occurrence of s2
-
substringBefore
Return the part of a string before a given substring, according to the rules of the XPath substring-before() function- Specified by:
substringBefore
in interfaceSubstringMatcher
- Parameters:
s1
- the containing strings2
- the contained string- Returns:
- the part of s1 that precedes the first occurrence of s2
-
getCollationKey
Get a collation key for two Strings. The essential property of collation keys is that if two values are equal under the collation, then the collation keys are compare correctly under the equals() method.- Specified by:
getCollationKey
in interfaceStringCollator
- Parameters:
s
- the string whose collation key is required- Returns:
- the collation key
-