net.sf.saxon.value

Class HexBinaryValue

public class HexBinaryValue extends AtomicValue

A value of type xs:hexBinary
Constructor Summary
HexBinaryValue(CharSequence in)
Constructor: create a hexBinary value from a supplied string, in which each octet is represented by a pair of values from 0-9, a-f, A-F
HexBinaryValue(CharSequence s, AtomicType type)
Constructor: create a HexBinary value from a supplied string in hexBinary encoding, with a specified type.
HexBinaryValue(byte[] value)
Constructor: create a hexBinary value from a given array of bytes
Method Summary
ConversionResultconvertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type
AtomicValuecopyAsSubType(AtomicType typeLabel)
Create a primitive copy of this atomic value (usually so that the type label can be changed).
booleanequals(Object other)
Test if the two hexBinary or Base64Binaryvalues are equal.
byte[]getBinaryValue()
Get the binary value
intgetLengthInOctets()
Get the number of octets in the value
CharSequencegetPrimitiveStringValue()
Convert to string
BuiltInAtomicTypegetPrimitiveType()
Determine the primitive type of the value.
ComparablegetSchemaComparable()
Support XML Schema comparison semantics
ObjectgetXPathComparable(boolean ordered, StringCollator collator, XPathContext context)
Get an object value that implements the XPath equality and ordering comparison semantics for this value.
inthashCode()

Constructor Detail

HexBinaryValue

public HexBinaryValue(CharSequence in)
Constructor: create a hexBinary value from a supplied string, in which each octet is represented by a pair of values from 0-9, a-f, A-F

Parameters: in character representation of the hexBinary value

HexBinaryValue

public HexBinaryValue(CharSequence s, AtomicType type)
Constructor: create a HexBinary value from a supplied string in hexBinary encoding, with a specified type. This method throws no checked exceptions; the caller is expected to ensure that the string is a valid Base64 lexical representation, that it conforms to the specified type, and that the type is indeed a subtype of xs:base64Binary. An unchecked exception such as an IllegalArgumentException may be thrown if these conditions are not satisfied, but this is not guaranteed.

Parameters: s the value in hexBinary encoding, with no leading or trailing whitespace type the atomic type. This must be xs:base64binary or a subtype.

HexBinaryValue

public HexBinaryValue(byte[] value)
Constructor: create a hexBinary value from a given array of bytes

Parameters: value the value as an array of bytes

Method Detail

convertPrimitive

public ConversionResult convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type

Parameters: requiredType an integer identifying the required atomic type context XPath dynamic evaluation context

Returns: an AtomicValue, a value of the required type; or an ErrorValue

copyAsSubType

public AtomicValue copyAsSubType(AtomicType typeLabel)
Create a primitive copy of this atomic value (usually so that the type label can be changed).

Parameters: typeLabel the target type (a derived type from hexBinary)

equals

public boolean equals(Object other)
Test if the two hexBinary or Base64Binaryvalues are equal.

getBinaryValue

public byte[] getBinaryValue()
Get the binary value

Returns: the binary value, as a byte array

getLengthInOctets

public int getLengthInOctets()
Get the number of octets in the value

Returns: the number of octets (bytes) in the value

getPrimitiveStringValue

public CharSequence getPrimitiveStringValue()
Convert to string

Returns: the canonical representation.

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.

getSchemaComparable

public Comparable getSchemaComparable()
Support XML Schema comparison semantics

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.

Parameters: 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 context the XPath dynamic evaluation context, used in cases where the comparison is context sensitive @return 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

hashCode

public int hashCode()