net.sf.saxon.value
Class Base64BinaryValue

java.lang.Object
  net.sf.saxon.value.Value
      net.sf.saxon.value.AtomicValue
          net.sf.saxon.value.Base64BinaryValue

All Implemented Interfaces:

Serializable, PullEvent, SequenceIterable, GroundedValue, Item, ValueRepresentation, ConversionResult

public class Base64BinaryValue
extends AtomicValue

A value of type xs:base64Binary

See Also:

Serialized Form

Field Summary

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

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

EMPTY_VALUE_ARRAY

Constructor Summary

Base64BinaryValue(byte[] value)
Constructor: create a base64Binary value from a given array of bytes

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.

Method Summary

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() Determine the primitive type of the value.
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, effectiveBooleanValue, getCardinality, getComponent, getItemType, getLength, getStringValueCS, getTypedValue, getTypeLabel, isNaN, itemAt, iterate, process, setTypeLabel, subsequence, toString

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

asItem, asItem, asIterator, asValue, convertJavaObjectToXPath, convertToJava, fromItem, getCanonicalLexicalRepresentation, getIterator, iterate, makeQNameValue, reduce, stringToNumber

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

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.

Throws:

XPathException

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 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

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 - the XPath dynamic evaluation context

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.

Returns:

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

getStringValue

public String getStringValue()

Convert to string

Specified by:

getStringValue in interface Item

Specified by:

getStringValue in interface ValueRepresentation

Specified by:

getStringValue in class AtomicValue

Returns:

the canonical representation.

See Also:

Item.getStringValueCS()

getLengthInOctets

public int getLengthInOctets()

Get the number of octets in the value

Returns:

the number of octets

convertToJava

public Object convertToJava(Class target,
                            XPathContext context)
                     throws XPathException

Convert to Java object (for passing to external functions)

Overrides:

convertToJava in class Value

Parameters:

target - the required target class

context - the XPath dynamic evaluation context

Returns:

the (boxed) Java object that best represents the XPath value

Throws:

XPathException

getSchemaComparable

public Comparable getSchemaComparable()

Support XML Schema comparison semantics

Specified by:

getSchemaComparable in class AtomicValue

Returns:

a Comparable that follows XML Schema comparison rules

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.

Specified by:

getXPathComparable in class 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

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(Object other)

Test if the two base64Binary values are equal.

Specified by:

equals in class AtomicValue

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()

Overrides:

hashCode in class Object