public class XdmValue extends java.lang.Object implements java.lang.Iterable<XdmItem>
An XdmValue is immutable.
A sequence consisting of a single item may be represented as an instance of XdmItem
,
which is a subtype of XdmValue. However, there is no guarantee that a sequence of length one
will always be an instance of XdmItem.
Similarly, a zero-length sequence may be represented as an instance of XdmEmptySequence
,
but there is no guarantee that every sequence of length zero will always be an instance of
XdmEmptySequence.
Modifier | Constructor and Description |
---|---|
protected |
XdmValue() |
|
XdmValue(java.lang.Iterable<XdmItem> items)
Create an XdmValue as a sequence of XdmItem objects
|
protected |
XdmValue(ValueRepresentation value) |
Modifier and Type | Method and Description |
---|---|
XdmValue |
append(XdmValue otherValue)
Create a new XdmValue by concatenating the contents of this XdmValue and another
XdmValue.
|
ValueRepresentation |
getUnderlyingValue()
Get the underlying implementation object representing the value.
|
XdmItem |
itemAt(int n)
Get the n'th item in the value, counting from zero.
|
XdmSequenceIterator |
iterator()
Get an iterator over the items in this value.
|
protected void |
setValue(ValueRepresentation value) |
int |
size()
Get the number of items in the sequence
|
protected static XdmValue |
wrap(ValueRepresentation value) |
protected XdmValue()
public XdmValue(java.lang.Iterable<XdmItem> items)
items
- a sequence of XdmItem objects. Note that if this is supplied as a list or similar
collection, subsequent changes to the list/collection will have no effect on the XdmValue.protected XdmValue(ValueRepresentation value)
protected void setValue(ValueRepresentation value)
protected static XdmValue wrap(ValueRepresentation value)
public XdmValue append(XdmValue otherValue)
otherValue
- the value to be appendedpublic int size()
SaxonApiUncheckedException
- if the value is lazily evaluated and the delayed
evaluation fails with a dynamic error.public XdmItem itemAt(int n) throws java.lang.IndexOutOfBoundsException, SaxonApiUncheckedException
n
- the item that is required, counting the first item in the sequence as item zerojava.lang.IndexOutOfBoundsException
- if n is less than zero or greater than or equal to the number
of items in the valueSaxonApiUncheckedException
- if the value is lazily evaluated and the delayed
evaluation fails with a dynamic error.public XdmSequenceIterator iterator() throws SaxonApiUncheckedException
iterator
in interface java.lang.Iterable<XdmItem>
SaxonApiUncheckedException
- if the value is lazily evaluated and the delayed
evaluation fails with a dynamic error.public ValueRepresentation getUnderlyingValue()