codepointEquals
public boolean codepointEquals(StringValue other)
Test whether this StringValue is equal to another under the rules of the codepoint collation
other
- the value to be compared with this value
- true if the strings are equal on a codepoint-by-codepoint basis
containsSurrogatePairs
public boolean containsSurrogatePairs()
Determine whether the string contains surrogate pairs
- true if the string contains any non-BMP characters
contract
public static CharSequence contract(int[] codes,
int used)
Contract an array of integers containing Unicode codepoints into a Java string
codes
- an array of integers representing the Unicode code pointsused
- the number of items in the array that are actually used
convertPrimitive
public ConversionResult convertPrimitive(BuiltInAtomicType requiredType,
boolean validate,
XPathContext context)
Convert a value to another primitive data type, with control over how validation is
handled.
- convertPrimitive in interface AtomicValue
requiredType
- type code of the required atomic typevalidate
- true if validation is required. If set to false, the caller guarantees that
the value is valid for the target data type, and that further validation is therefore not required.
Note that a validation failure may be reported even if validation was not requested.context
- XPath dynamic context. Used only where the target type is one such as
NCName whose definition is context-sensitive
- the result of the conversion, if successful. If unsuccessful, the value returned
will be a ValidationErrorValue. The caller must check for this condition. No exception is thrown, instead
the exception will be encapsulated within the ErrorValue.
convertStringToAtomicType
public static ConversionResult convertStringToAtomicType(CharSequence value,
AtomicType targetType,
NameChecker checker)
Convert the value to a given type. The result of the conversion will be
an atomic value of the required type. This method works where the target
type is a built-in atomic type and also where it is a user-defined atomic
type. It does not handle namespace-sensitive types (QName, NOTATION, and derivatives).
value
- the value to be convertedtargetType
- the type to which the value is to be convertedchecker
- a NameChecker if validation is required, null if the caller already knows that the
value is valid. Note that a non-null NameChecker acts as a signal that validation is
required, even when the value to be checked is not a name.
- the value after conversion if successful; or a
ValidationFailure
if conversion failed. The
caller must check for this condition. Validation may fail even if validation was not requested.
convertStringToBuiltInType
public static ConversionResult convertStringToBuiltInType(CharSequence value,
BuiltInAtomicType requiredType,
NameChecker checker)
Convert a string value to another built-in data type, with control over how validation is
handled.
value
- the value to be convertedrequiredType
- the required atomic typechecker
- if validation is required, a NameChecker. If set to null, the caller guarantees that
the value is valid for the target data type, and that further validation is therefore not required.
Note that a validation failure may be reported even if validation was not requested.
- the result of the conversion, if successful. If unsuccessful, the value returned
will be a
ValidationFailure
. The caller must check for this condition. No exception is thrown, instead
the exception will be encapsulated within the ValidationFailure.
copyAsSubType
public AtomicValue copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label
- copyAsSubType in interface AtomicValue
typeLabel
- the type label of the new copy. The caller is responsible for checking that
the value actually conforms to this type.
diagnosticDisplay
public static String diagnosticDisplay(String s)
Produce a diagnostic representation of the contents of the string
- a string in which non-Ascii-printable characters are replaced by \ uXXXX escapes
effectiveBooleanValue
public boolean effectiveBooleanValue()
Get the effective boolean value of a string
- effectiveBooleanValue in interface AtomicValue
- true if the string has length greater than zero
equals
public boolean equals(Object other)
Determine if two AtomicValues are equal, according to XPath rules. (This method
is not used for string comparisons, which are always under the control of a collation.
If we get here, it's because there's a type error in the comparison.)
- equals in interface AtomicValue
expand
public int[] expand()
Expand a string containing surrogate pairs into an array of 32-bit characters
- an array of integers representing the Unicode code points
expand
public static int[] expand(CharSequence s)
Expand a string containing surrogate pairs into an array of 32-bit characters
s
- the string to be expanded
- an array of integers representing the Unicode code points
getPrimitiveType
public BuiltInAtomicType getPrimitiveType()
Determine the primitive type of the value. This delivers the same answer as
getItemType().getPrimitiveItemType(). The primitive types are
the 19 primitive types of XML Schema, plus xs:integer, xs:dayTimeDuration and xs:yearMonthDuration,
and xs:untypedAtomic. For external objects, the result is AnyAtomicType.
- getPrimitiveType in interface AtomicValue
getSchemaComparable
public Comparable getSchemaComparable()
Get a Comparable value that implements the XML Schema comparison semantics for this value.
Returns null if the value is not comparable according to XML Schema rules. This implementation
returns the underlying Java string, which works because strings will only be compared for
equality, not for ordering, and the equality rules for strings in XML schema are the same as in Java.
- getSchemaComparable in interface AtomicValue
getStringLength
public int getStringLength()
Get the length of this string, as defined in XPath. This is not the same as the Java length,
as a Unicode surrogate pair counts as a single character
- the length of the string in Unicode code points
getStringLength
public static int getStringLength(CharSequence s)
Get the length of a string, as defined in XPath. This is not the same as the Java length,
as a Unicode surrogate pair counts as a single character.
s
- The string whose length is required
- the length of the string in Unicode code points
getXPathComparable
public Object getXPathComparable(boolean ordered,
StringCollator collator,
XPathContext context)
Get an object value that implements the XPath equality and ordering comparison semantics for this value.
If the ordered parameter is set to true, the result will be a Comparable and will support a compareTo()
method with the semantics of the XPath lt/gt operator, provided that the other operand is also obtained
using the getXPathComparable() method. In all cases the result will support equals() and hashCode() methods
that support the semantics of the XPath eq operator, again provided that the other operand is also obtained
using the getXPathComparable() method. A context argument is supplied for use in cases where the comparison
semantics are context-sensitive, for example where they depend on the implicit timezone or the default
collation.
- getXPathComparable in interface AtomicValue
ordered
- true if an ordered comparison is required. In this case the result is null if the
type is unordered; in other cases the returned value will be a Comparable.collator
- Collation to be used for comparing stringscontext
- the XPath dynamic evaluation context, used in cases where the comparison is context
sensitive
- an Object whose equals() and hashCode() methods implement the XPath comparison semantics
with respect to this atomic value. If ordered is specified, the result will either be null if
no ordering is defined, or will be a Comparable
isZeroLength
public boolean isZeroLength()
Determine whether the string is a zero-length string. This may
be more efficient than testing whether the length is equal to zero
- true if the string is zero length
iterateCharacters
public UnfailingIterator iterateCharacters()
Iterate over a string, returning a sequence of integers representing the Unicode code-point values
- an iterator over the characters (Unicode code points) in the string
makeRestrictedString
public static ConversionResult makeRestrictedString(CharSequence value,
BuiltInAtomicType typeLabel,
NameChecker checker)
Factory method to create a string value belonging to a built-in type derived from string
value
- the String value. Null is taken as equivalent to "".typeLabel
- the required type, must be a built in type derived from xs:stringchecker
- a NameChecker if validation is required,
null if the caller already knows that the value is valid
- either the required StringValue if the value is valid, or a ValidationFailure encapsulating
the error message if not.
makeStringValue
public static StringValue makeStringValue(CharSequence value)
Factory method. Unlike the constructor, this avoids creating a new StringValue in the case
of a zero-length string (and potentially other strings, in future)
value
- the String value. Null is taken as equivalent to "".
- the corresponding StringValue
setStringValueCS
public final void setStringValueCS(CharSequence value)
Set the value of the item as a CharSequence.
For system use only. In principle, a StringValue is immutable. However, in special circumstances,
if it is newly constructed, the content can be changed to reflect the effect of the whiteSpace facet.
value
- the value of the string
toString
public String toString()
Get string value. In general toString() for an atomic value displays the value as it would be
written in XPath: that is, as a literal if available, or as a call on a constructor function
otherwise.
- toString in interface AtomicValue
validate
public static ValidationFailure validate(BuiltInAtomicType typeLabel,
CharSequence val,
NameChecker checker)
Validate that the string conforms to the rules for a built-in subtype of xs:string
typeLabel
- the built-in atomic type against which the string should be validatedval
- the string to be validatedchecker
- object that checks names against the XML 1.0 or XML 1.1 rules as appropriate
- null if the value is OK, otherwise a ValidationException containing details of the failure