|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.saxon.value.Value
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.StringValue
An atomic value of type xs:string
Nested Class Summary | |
class |
StringValue.CharacterIterator
CharacterIterator is used to iterate over the characters in a string, returning them as integers representing the Unicode code-point. |
Field Summary | |
static StringValue |
EMPTY_STRING
|
static StringValue |
FALSE
|
protected int |
length
|
static StringValue |
SINGLE_SPACE
|
static StringValue |
TRUE
|
protected java.lang.CharSequence |
value
|
Fields inherited from class net.sf.saxon.value.Value |
EMPTY_CLASS_ARRAY |
Fields inherited from interface net.sf.saxon.om.ValueRepresentation |
EMPTY_VALUE_ARRAY |
Fields inherited from interface net.sf.saxon.expr.Expression |
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD |
Constructor Summary | |
protected |
StringValue()
Protected constructor for use by subtypes |
|
StringValue(java.lang.CharSequence value)
Constructor. |
Method Summary | |
boolean |
codepointEquals(StringValue other)
Test whether this StringValue is equal to another under the rules of the codepoint collation |
boolean |
containsSurrogatePairs()
Determine whether the string contains surrogate pairs |
static java.lang.CharSequence |
contract(int[] codes,
int used)
Contract an array of integers containing Unicode codepoints into a Java string |
AtomicValue |
convertPrimitive(BuiltInAtomicType requiredType,
boolean validate,
XPathContext context)
Convert a value to another primitive data type, with control over how validation is handled. |
static AtomicValue |
convertStringToAtomicType(java.lang.CharSequence value,
AtomicType targetType,
NameChecker checker)
Convert the value to a given type. |
static AtomicValue |
convertStringToBuiltInType(java.lang.CharSequence value,
BuiltInAtomicType requiredType,
NameChecker checker)
Convert a string value to another built-in data type, with control over how validation is handled. |
java.lang.Object |
convertToJava(java.lang.Class target,
XPathContext context)
Convert to Java object (for passing to external functions) |
boolean |
effectiveBooleanValue(XPathContext context)
Get the effective boolean value of a string |
boolean |
equals(java.lang.Object other)
Determine if two StringValues are equal, according to XML Schema rules. |
int[] |
expand()
Expand a string containing surrogate pairs into an array of 32-bit characters |
static int[] |
expand(java.lang.CharSequence s)
Expand a string containing surrogate pairs into an array of 32-bit characters |
ItemType |
getItemType(TypeHierarchy th)
Return the type of the expression |
int |
getStringLength()
Get the length of this string, as defined in XPath. |
static int |
getStringLength(java.lang.CharSequence s)
Get the length of a string, as defined in XPath. |
java.lang.String |
getStringValue()
Get the string value as a String |
java.lang.CharSequence |
getStringValueCS()
Get the value of the item as a CharSequence. |
int |
hashCode()
Return a hash code to support the equals() function |
boolean |
isZeroLength()
Determine whether the string is a zero-length string. |
SequenceIterator |
iterateCharacters()
Iterate over a string, returning a sequence of integers representing the Unicode code-point values |
static StringValue |
makeStringValue(java.lang.CharSequence value)
Factory method. |
java.lang.String |
toString()
Get string value. |
Methods inherited from class net.sf.saxon.value.AtomicValue |
checkPermittedContents, convert, convert, display, evaluateAsString, evaluateItem, getCardinality, getComponent, getImplementationMethod, getLength, getPrimitiveValue, getTypedValue, hasBuiltInType, iterate, process |
Methods inherited from class net.sf.saxon.value.Value |
asItem, asIterator, asValue, convert, convertJavaObjectToXPath, getDependencies, getIterator, getParentExpression, getSpecialProperties, itemAt, iterateSubExpressions, makeQNameValue, optimize, promote, reduce, simplify, stringToNumber, typeCheck |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final StringValue EMPTY_STRING
public static final StringValue SINGLE_SPACE
public static final StringValue TRUE
public static final StringValue FALSE
protected java.lang.CharSequence value
protected int length
Constructor Detail |
protected StringValue()
public StringValue(java.lang.CharSequence value)
value
- the String value. Null is taken as equivalent to "".Method Detail |
public static StringValue makeStringValue(java.lang.CharSequence value)
value
- the String value. Null is taken as equivalent to "".
public final java.lang.String getStringValue()
getStringValue
in interface Item
getStringValue
in class AtomicValue
public final java.lang.CharSequence getStringValueCS()
getStringValueCS
in interface Item
getStringValueCS
in class AtomicValue
public AtomicValue convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
convertPrimitive
in class 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
-
public static AtomicValue convertStringToBuiltInType(java.lang.CharSequence value, BuiltInAtomicType requiredType, NameChecker checker)
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.
ValidationErrorValue
. The caller must check for this condition. No exception is thrown, instead
the exception will be encapsulated within the ValidationErrorValue.public static AtomicValue convertStringToAtomicType(java.lang.CharSequence value, AtomicType targetType, NameChecker checker)
targetType
- 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
ValidationErrorValue
if conversion failed. The
caller must check for this condition. Validation may fail even if validation was not requested.public ItemType getItemType(TypeHierarchy th)
getItemType
in interface Expression
getItemType
in class Value
th
-
public int getStringLength()
public static int getStringLength(java.lang.CharSequence s)
s
- The string whose length is requiredpublic boolean isZeroLength()
public boolean containsSurrogatePairs()
public SequenceIterator iterateCharacters()
public int[] expand()
public static int[] expand(java.lang.CharSequence s)
public static java.lang.CharSequence contract(int[] codes, int used)
public boolean equals(java.lang.Object other)
equals
in class Value
java.lang.ClassCastException
- if the values are not comparablepublic int hashCode()
Value
hashCode
in class Value
public boolean codepointEquals(StringValue other)
public boolean effectiveBooleanValue(XPathContext context)
effectiveBooleanValue
in interface Expression
effectiveBooleanValue
in class AtomicValue
context
- not used
public java.lang.Object convertToJava(java.lang.Class target, XPathContext context) throws XPathException
convertToJava
in class Value
XPathException
public java.lang.String toString()
AtomicValue
toString
in class AtomicValue
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |