Package net.sf.saxon.str

Class Latin1

java.lang.Object

net.sf.saxon.str.UnicodeString

net.sf.saxon.str.Twine8

net.sf.saxon.str.Latin1

All Implemented Interfaces:

Comparable<UnicodeString>, AtomicMatchKey

public class Latin1
extends Twine8

An implementation of UnicodeString that subclasses Twine8 (so it is only suitable for codepoints up to 255), and that also caches a String representing the same characters. This is wasteful of space, so it is used predominantly for static constants.

Field Summary

Fields inherited from class net.sf.saxon.str.Twine8

bytes, cachedHash

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Latin1(String baseString)	Protected constructor

Method Summary

Modifier and Type	Method	Description
int	compareTo(UnicodeString other)	Compare this string to another using codepoint comparison
boolean	equals(Object obj)	Test whether this StringValue is equal to another under the rules of the codepoint collation.
static Latin1	of(String base)	Wrap a String, which must contain no surrogates
String	toString()	Display as a string.

Methods inherited from class net.sf.saxon.str.Twine8

codePointAt, codePoints, details, getByteArray, getWidth, hashCode, indexOf, indexOf, indexWhere, isEmpty, iterate, length, length32, substring

Methods inherited from class net.sf.saxon.str.UnicodeString

asAtomic, checkSubstringBounds, concat, economize, estimatedLength, fromLong, hasSubstring, indexOf, longHashCode, prefix, requireInt, requireNonNegativeInt, substring, tidy

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Latin1

protected Latin1(String baseString)

Protected constructor

Parameters:

baseString - the string to be wrapped: the caller is responsible for ensuring this contains no codepoints above 255

Method Details

of

public static Latin1 of(String base)

Wrap a String, which must contain no surrogates

Parameters:

base - the string. The caller warrants that this string contains no surrogates; this condition is checked only if Java assertions are enabled.

Returns:

the wrapped string.

compareTo

public int compareTo(UnicodeString other)

Description copied from class: UnicodeString

Compare this string to another using codepoint comparison

Specified by:

compareTo in interface Comparable<UnicodeString>

Overrides:

compareTo in class Twine8

Parameters:

other - the other string

Returns:

-1 if this string comes first, 0 if they are equal, +1 if the other string comes first

equals

public boolean equals(Object obj)

Description copied from class: Twine8

Test whether this StringValue is equal to another under the rules of the codepoint collation. The type annotation is ignored.

Overrides:

equals in class Twine8

Parameters:

obj - the value to be compared with this value

Returns:

true if the strings are equal on a codepoint-by-codepoint basis

toString

public String toString()

Description copied from class: Twine8

Display as a string.

Overrides:

toString in class Twine8