net.sf.saxon.value

Class Base64BinaryValue

java.lang.Object

net.sf.saxon.value.AtomicValue

net.sf.saxon.value.Base64BinaryValue

All Implemented Interfaces:

java.lang.Comparable<XPathComparable>, java.lang.Iterable<AtomicValue>, AtomicMatchKey, XPathComparable, AtomicSequence, GroundedValue, IdentityComparable, Item, Sequence, ConversionResult, ContextFreeAtomicValue

public class Base64BinaryValue
extends AtomicValue
implements AtomicMatchKey, XPathComparable, ContextFreeAtomicValue

A value of type xs:base64Binary

Field Summary

Fields inherited from class net.sf.saxon.value.AtomicValue

typeLabel

Constructor Summary

Constructors

Constructor and Description
Base64BinaryValue(byte[] value) Constructor: create a base64Binary value from a given array of bytes
Base64BinaryValue(UnicodeString s) Constructor: create a base64Binary value from a supplied string in base64 encoding

Method Summary

Modifier and Type	Method and Description
protected static int	byteArrayHashCode(byte[] value)
int	compareTo(XPathComparable o)
AtomicValue	copyAsSubType(AtomicType typeLabel) Create a copy of this atomic value (usually so that the type label can be changed).
static byte[]	decode(UnicodeString in) Decode a character string in base64 notation to yield the encoded octets
static UnicodeString	encode(byte[] value) Encode a byte sequence into base64 representation
boolean	equals(java.lang.Object other) Test if the two base64Binary values are equal.
byte[]	getBinaryValue() Get the binary value
int	getLengthInOctets() Get the number of octets in the value
UnicodeString	getPrimitiveStringValue() Convert to string
BuiltInAtomicType	getPrimitiveType() Determine the primitive type of the value.
XPathComparable	getXPathComparable() Get an XPathComparable object that supports the semantics of context-free eq and lt comparisons between atomic values.
XPathComparable	getXPathComparable(StringCollator collator, int implicitTimezone) Get an object value that implements the XPath equality and ordering comparison semantics for this value.
AtomicMatchKey	getXPathMatchKey(StringCollator collator, int implicitTimezone) Get an object value that implements the XPath equality and ordering comparison semantics for this value.
int	hashCode() Returns a hash code value for the object.

Methods inherited from class net.sf.saxon.value.AtomicValue

asAtomic, asMapKey, atomize, checkPermittedContents, checkValidInJavascript, effectiveBooleanValue, getCanonicalLexicalRepresentation, getCardinality, getComponent, getGenre, getItemType, getLength, getUnicodeStringValue, getUType, head, identityHashCode, isIdentical, isIdentical, isNaN, isUntypedAtomic, itemAt, iterate, iterator, setTypeLabel, show, toShortString, 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.Item

getStringValue, isStreamed, reduce, subsequence

Methods inherited from interface net.sf.saxon.om.GroundedValue

asIterable, concatenate, containsNode, materialize

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Base64BinaryValue

public Base64BinaryValue(UnicodeString s)
                  throws XPathException

Constructor: create a base64Binary value from a supplied string in base64 encoding

Parameters:

s - the lexical representation of the base64 binary value. There is no requirement that whitespace should already be collapsed.

Throws:

XPathException - if the supplied value is not in the lexical space of the xs:base64Binary data type

Base64BinaryValue

public Base64BinaryValue(byte[] value)

Constructor: create a base64Binary value from a given array of bytes

Parameters:

value - array of bytes holding the octet sequence

Method Detail

copyAsSubType

public AtomicValue copyAsSubType(AtomicType typeLabel)

Create a copy of this atomic value (usually so that the type label can be changed). The type label of the copy will be reset to the primitive type.

Specified by:

copyAsSubType in class AtomicValue

Parameters:

typeLabel - the type label to be attached to the value, a subtype of xs:base64Binary

Returns:

the copied value

getBinaryValue

public byte[] getBinaryValue()

Get the binary value

Returns:

the octet sequence that is the typed value

getPrimitiveType

public BuiltInAtomicType getPrimitiveType()

Description copied from class: AtomicValue

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 xs:anyAtomicType.

Specified by:

getPrimitiveType in class AtomicValue

Returns:

the primitive type

getPrimitiveStringValue

public UnicodeString getPrimitiveStringValue()

Convert to string

Specified by:

getPrimitiveStringValue in class AtomicValue

Returns:

the canonical representation.

getLengthInOctets

public int getLengthInOctets()

Get the number of octets in the value

Returns:

the number of octets

getXPathComparable

public XPathComparable getXPathComparable(StringCollator collator,
                                          int implicitTimezone)
                                   throws NoDynamicContextException

Description copied from class: AtomicValue

Get an object value that implements the XPath equality and ordering comparison semantics for this value. A collation is supplied for comparing strings, and an implicit timezone for comparing date/time values that have no saved timezone. An atomic value may return itself as the result, provided that its ordering rules are independent of the collation and timezone, and provided that it implements the XPathComparable interface: which means that its compareTo, equals, and hashCode methods must be compatible with the rules for XPath value comparisons.

Specified by:

getXPathComparable in class AtomicValue

Parameters:

collator - the collation to be used when comparing strings

implicitTimezone - the implicit timezone in the dynamic context, used when comparing dates/times with and without timezone

Returns:

an Object that implements the XPath value comparison semantics with respect to this atomic value. For an atomic type that is not ordered (according to XPath rules), return null.

Throws:

NoDynamicContextException - if the supplied implicit timezone is "NO_TIMEZONE" (meaning unknown), and the implicit timezone is actually required because the value in question is a date/time value with no timezone. This can cause a failure to evaluate expressions statically (because the implicit timezone is not known statically), and it will then be caught, meaning that the expression has to be evaluated dynamically.

getXPathComparable

public XPathComparable getXPathComparable()

Description copied from interface: ContextFreeAtomicValue

Get an XPathComparable object that supports the semantics of context-free eq and lt comparisons between atomic values. Note that in many cases the returned XPathComparable will be the AtomicValue itself; however because of the constaints of the generic Comparable interface, this cannot be assumed.

Specified by:

getXPathComparable in interface ContextFreeAtomicValue

Returns:

an XPathComparable that can be used in comparisons with other atomic values.

getXPathMatchKey

public AtomicMatchKey getXPathMatchKey(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:

getXPathMatchKey in class AtomicValue

Parameters:

collator - the collation (not used in this version of the method)

implicitTimezone - the XPath dynamic evaluation context, used in cases where the comparison is context

Returns:

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

equals

public boolean equals(java.lang.Object other)

Test if the two base64Binary values are equal.

Overrides:

equals in class AtomicValue

Parameters:

other - the other value

Returns:

true (in a subclass) 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()

Description copied from class: AtomicValue

Returns a hash code value for the object.

Overrides:

hashCode in class AtomicValue

byteArrayHashCode

protected static int byteArrayHashCode(byte[] value)

encode

public static UnicodeString encode(byte[] value)

Encode a byte sequence into base64 representation

Parameters:

value - the byte sequence

Returns:

the base64 representation

decode

public static byte[] decode(UnicodeString in)
                     throws XPathException

Decode a character string in base64 notation to yield the encoded octets

Parameters:

in - the lexical representation

Returns:

the array of octets represented

Throws:

XPathException - if the format is invalid (as required by XSD, this method does draconian error handling, unlike many other base64 decoders which are liberal in what they accept)

compareTo

public int compareTo(XPathComparable o)

Specified by:

compareTo in interface java.lang.Comparable<XPathComparable>