Package net.sf.saxon.value
Class HexBinaryValue
java.lang.Object
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.HexBinaryValue
- All Implemented Interfaces:
Comparable
,Iterable<AtomicValue>
,AtomicMatchKey
,AtomicSequence
,GroundedValue
,IdentityComparable
,Item
,Sequence
,ConversionResult
A value of type xs:hexBinary
-
Field Summary
Fields inherited from class net.sf.saxon.value.AtomicValue
typeLabel
Fields inherited from interface net.sf.saxon.expr.sort.AtomicMatchKey
NaN_MATCH_KEY
-
Constructor Summary
ConstructorsConstructorDescriptionHexBinaryValue
(byte[] value) Constructor: create a hexBinary value from a given array of bytesConstructor: 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-FHexBinaryValue
(CharSequence s, AtomicType type) Constructor: create a HexBinary value from a supplied string in hexBinary encoding, with a specified type. -
Method Summary
Modifier and TypeMethodDescriptionint
copyAsSubType
(AtomicType typeLabel) Create a primitive copy of this atomic value (usually so that the type label can be changed).boolean
Test if the two hexBinary or Base64Binaryvalues are equal.byte[]
Get the binary valueint
Get the number of octets in the valueConvert to stringDetermine the primitive type of the value.Comparable
<net.sf.saxon.value.HexBinaryValue.HexBinaryComparable> Support XML Schema comparison semanticsgetXPathComparable
(boolean ordered, StringCollator collator, int implicitTimezone) Get an object value that implements the XPath equality and ordering comparison semantics for this value.int
hashCode()
Methods inherited from class net.sf.saxon.value.AtomicValue
asAtomic, asMapKey, atomize, checkPermittedContents, checkValidInJavascript, effectiveBooleanValue, getCanonicalLexicalRepresentation, getCardinality, getComponent, getGenre, getItemType, getLength, getStringValue, getStringValueCS, getUType, head, identityHashCode, isIdentical, isIdentical, isNaN, itemAt, iterate, iterator, setTypeLabel, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface net.sf.saxon.expr.sort.AtomicMatchKey
asAtomic
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materialize
Methods inherited from interface net.sf.saxon.om.Item
isStreamed, reduce, subsequence, toShortString
Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Constructor Details
-
HexBinaryValue
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- Throws:
XPathException
- if the input is invalid
-
HexBinaryValue
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 whitespacetype
- 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 Details
-
copyAsSubType
Create a primitive copy of this atomic value (usually so that the type label can be changed).- Specified by:
copyAsSubType
in classAtomicValue
- Parameters:
typeLabel
- the target type (a derived type from hexBinary)- Returns:
- the copied value
-
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.- Specified by:
getPrimitiveType
in classAtomicValue
- Returns:
- the primitive type
-
getBinaryValue
public byte[] getBinaryValue()Get the binary value- Returns:
- the binary value, as a byte array
-
getPrimitiveStringValue
Convert to string- Specified by:
getPrimitiveStringValue
in classAtomicValue
- Returns:
- the canonical representation.
-
getLengthInOctets
public int getLengthInOctets()Get the number of octets in the value- Returns:
- the number of octets (bytes) in the value
-
getSchemaComparable
Support XML Schema comparison semantics- Specified by:
getSchemaComparable
in interfaceAtomicSequence
- Specified by:
getSchemaComparable
in classAtomicValue
- Returns:
- a Comparable that follows XML Schema comparison rules
-
getXPathComparable
public AtomicMatchKey getXPathComparable(boolean ordered, StringCollator collator, int implicitTimezone) 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.- Specified by:
getXPathComparable
in classAtomicValue
- 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
- collation to be used for comparing stringsimplicitTimezone
- to be used for comparing dates/times with no timezone- Returns:
- a key used for performing the comparison
-
equals
Test if the two hexBinary or Base64Binaryvalues are equal.- Specified by:
equals
in classAtomicValue
- Parameters:
other
- the other value- Returns:
- true if the other operand is an atomic value and the two values are equal as defined by the XPath eq operator
-
hashCode
public int hashCode() -
compareTo
- Specified by:
compareTo
in interfaceComparable
-