net.sf.saxon.value

Class Base64BinaryValue

Implemented Interfaces:
ConversionResult, GroundedValue, Item, PullEvent, Serializable, SequenceIterable, Serializable, ValueRepresentation

public class Base64BinaryValue
extends AtomicValue

A value of type xs:base64Binary

Field Summary

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

typeLabel

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

EMPTY_CLASS_ARRAY, INDETERMINATE_ORDERING

Fields inherited from interface net.sf.saxon.om.ValueRepresentation

EMPTY_VALUE_ARRAY

Constructor Summary

Base64BinaryValue(CharSequence s)
Constructor: create a base64Binary value from a supplied string in base64 encoding
Base64BinaryValue(CharSequence s, AtomicType type)
Constructor: create a base64Binary value from a supplied string in base64 encoding, with a specified type.
Base64BinaryValue(byte[] value)
Constructor: create a base64Binary value from a given array of bytes

Method Summary

protected static int
byteArrayHashCode(byte[] value)
ConversionResult
convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type
Object
convertToJava(Class target, XPathContext context)
Convert to Java object (for passing to external functions)
AtomicValue
copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value (usually so that the type label can be changed).
boolean
equals(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
BuiltInAtomicType
getPrimitiveType()
Comparable
getSchemaComparable()
Support XML Schema comparison semantics
String
getStringValue()
Convert to string
Object
getXPathComparable(boolean ordered, StringCollator collator, XPathContext context)
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, checkPermittedContents, convert, convert, convertPrimitive, copyAsSubType, effectiveBooleanValue, equals, getCardinality, getComponent, getItemType, getLength, getPrimitiveType, getSchemaComparable, getStringValue, getStringValueCS, getTypeLabel, getTypedValue, getXPathComparable, isNaN, itemAt, iterate, process, setTypeLabel, subsequence, toString

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

asItem, asItem, asIterator, asValue, checkPermittedContents, convertJavaObjectToXPath, convertToJava, convertToJava, effectiveBooleanValue, equals, fromItem, getCanonicalLexicalRepresentation, getCardinality, getItemType, getIterator, getLength, getSchemaComparable, getStringValue, getStringValueCS, itemAt, iterate, iterate, makeQNameValue, process, reduce, stringToNumber, toString

Constructor Details

Base64BinaryValue

public Base64BinaryValue(CharSequence 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.

Base64BinaryValue

public Base64BinaryValue(CharSequence s,
                         AtomicType type)
Constructor: create a base64Binary value from a supplied string in base64 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 base64 encoding
type - the atomic type. This must be xs:base64binary or a subtype.

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 Details

byteArrayHashCode

protected static int byteArrayHashCode(byte[] value)

convertPrimitive

public ConversionResult convertPrimitive(BuiltInAtomicType requiredType,
                                         boolean validate,
                                         XPathContext context)
Convert to target data type
Overrides:
convertPrimitive in interface AtomicValue
Parameters:
requiredType - an integer identifying the required atomic type
context - the XPath dynamic evaluation context
Returns:
an AtomicValue, a value of the required type; or an ErrorValue

convertToJava

public Object convertToJava(Class target,
                            XPathContext context)
            throws XPathException
Convert to Java object (for passing to external functions)
Overrides:
convertToJava in interface Value

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.
Overrides:
copyAsSubType in interface AtomicValue
Parameters:
typeLabel - the type label to be attached to the value, a subtype of xs:base64Binary
Returns:
the copied value

equals

public boolean equals(Object other)
Test if the two base64Binary values are equal.
Overrides:
equals in interface AtomicValue

getBinaryValue

public byte[] getBinaryValue()
Get the binary value
Returns:
the octet sequence that is the typed value

getLengthInOctets

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

getPrimitiveType

public BuiltInAtomicType getPrimitiveType()
Overrides:
getPrimitiveType in interface AtomicValue

getSchemaComparable

public Comparable getSchemaComparable()
Support XML Schema comparison semantics
Overrides:
getSchemaComparable in interface AtomicValue

getStringValue

public String getStringValue()
Convert to string
Specified by:
getStringValue in interface Item
getStringValue in interface ValueRepresentation
Overrides:
getStringValue in interface AtomicValue
Returns:
the canonical representation.

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.
Overrides:
getXPathComparable in interface AtomicValue
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()