Package com.amazon.ion

Interface RawValueSpanProvider

@Deprecated
public interface RawValueSpanProvider

Deprecated.

This is a private API subject to change without notice.

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	Description
byte[]	buffer()	Deprecated.
Span	valueSpan()	Deprecated. Constructs a Span, which may be faceted as an OffsetSpan, that provides the start and end byte positions of the current value.

Method Detail

valueSpan

Span valueSpan()

Deprecated.

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:

the constructed Span

buffer

byte[] buffer()

Deprecated.

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.