Ion Java 1.11.10 · com.amazon.ion.RawValueSpanProvider

Provide the ability to retrieve Spans (abstract value positions) of raw Ion values, excluding type and length octets.

Warning

This interface should not be implemented or extended by code outside of this library.

This functionality may be accessed as a facet of binary IonReaders.

Method Summary

Modifier and Type	Method and Description
public byte[]	Returns: the byte[] that backs this span. This span's start and end positions may be used as indices into the returned buffer. Note does NOT perform a copy of the buffer; care must be taken not to mutate and corrupt the data. buffer()
public Span	Returns: the constructed Span valueSpan() Constructs a Span, which may be faceted as an `OffsetSpan`, that provides the start and end byte positions of the current value.

Method Detail

buffer	back to summary
public byte[] buffer() Returns:byte[] the byte[] that backs this span. This span's start and end positions may be used as indices into the returned buffer. Note does NOT perform a copy of the buffer; care must be taken not to mutate and corrupt the data.

valueSpan back to summary

valueSpan	back to summary
public Span valueSpan() Constructs a Span, which may be faceted as an `OffsetSpan`, that provides the start and end byte positions of the current value. Note for Ion `int` values, users should not use these byte positions to determine which primitive (if any) the value can fit into, because the sign of Ion `int` values is encoded into the type ID byte, which is not included in this span. Warning Spans provided by this method are not compatible with the `SeekableReader` facet, because they lack the type ID and length bytes that are important when reconstructing the context on seek. For `SpanProvider#currentSpan()` should be used to retrieve seekable Spans. Returns:Span the constructed Span

public Span valueSpan()

Constructs a Span, which may be faceted as an OffsetSpan, that provides the start and end byte positions of the current value.

Note

for Ion int values, users should not use these byte positions to determine which primitive (if any) the value can fit into, because the sign of Ion int values is encoded into the type ID byte, which is not included in this span.

Warning

Spans provided by this method are not compatible with the SeekableReader facet, because they lack the type ID and length bytes that are important when reconstructing the context on seek. For SpanProvider#currentSpan() should be used to retrieve seekable Spans.

Returns:Span: the constructed Span

public Interface RawValueSpanProvider

Method Summary

Method Detail