Class StringValue

    • Field Detail

      • EMPTY_STRING

        public static final StringValue EMPTY_STRING
      • SINGLE_SPACE

        public static final StringValue SINGLE_SPACE
      • value

        protected java.lang.CharSequence value
      • length

        protected int length
    • Constructor Detail

      • StringValue

        protected StringValue()
        Protected constructor for use by subtypes
      • StringValue

        public StringValue​(java.lang.CharSequence value)
        Constructor. Note that although a StringValue may wrap any kind of CharSequence (usually a String, but it can also be, for example, a StringBuffer), the caller is responsible for ensuring that the value is immutable.
        Parameters:
        value - the String value. Null is taken as equivalent to "".
    • Method Detail

      • makeStringValue

        public static StringValue makeStringValue​(java.lang.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)
        Parameters:
        value - the String value. Null is taken as equivalent to "".
        Returns:
        the corresponding StringValue
      • convertPrimitive

        public AtomicValue convertPrimitive​(BuiltInAtomicType requiredType,
                                            boolean validate,
                                            XPathContext context)
        Convert a value to another primitive data type, with control over how validation is handled.
        Specified by:
        convertPrimitive in class AtomicValue
        Parameters:
        requiredType - type code of the required atomic type
        validate - 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 -
        Returns:
        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.
      • convertStringToBuiltInType

        public 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.
        Parameters:
        value - the value to be converted
        requiredType - the required atomic type
        checker - 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.
        Returns:
        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 ValidationErrorValue.
      • convertStringToAtomicType

        public static AtomicValue convertStringToAtomicType​(java.lang.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.
        Parameters:
        targetType - the type to which the value is to be converted
        checker - a NameChecker if validation is required, null if the caller already knows that the value is valid
        Returns:
        the value after conversion if successful; or a ValidationErrorValue if conversion failed. The caller must check for this condition. Validation may fail even if validation was not requested.
      • 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
      • getStringLength

        public static int getStringLength​(java.lang.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.
        Parameters:
        s - The string whose length is required
      • 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
      • containsSurrogatePairs

        public boolean containsSurrogatePairs()
        Determine whether the string contains surrogate pairs
        Returns:
        true if the string contains any non-BMP characters
      • iterateCharacters

        public SequenceIterator iterateCharacters()
        Iterate over a string, returning a sequence of integers representing the Unicode code-point values
      • expand

        public int[] expand()
        Expand a string containing surrogate pairs into an array of 32-bit characters
      • expand

        public static int[] expand​(java.lang.CharSequence s)
        Expand a string containing surrogate pairs into an array of 32-bit characters
      • contract

        public static java.lang.CharSequence contract​(int[] codes,
                                                      int used)
        Contract an array of integers containing Unicode codepoints into a Java string
      • equals

        public boolean equals​(java.lang.Object other)
        Determine if two StringValues are equal, according to XML Schema rules. (This method is not used for XPath comparisons, which are always under the control of a collation.)
        Overrides:
        equals in class Value
        Throws:
        java.lang.ClassCastException - if the values are not comparable
      • hashCode

        public int hashCode()
        Description copied from class: Value
        Return a hash code to support the equals() function
        Overrides:
        hashCode in class Value
      • codepointEquals

        public boolean codepointEquals​(StringValue other)
        Test whether this StringValue is equal to another under the rules of the codepoint collation
      • toString

        public java.lang.String toString()
        Description copied from class: AtomicValue
        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.
        Overrides:
        toString in class AtomicValue