Ion Java 1.11.10 · com.amazon.ion · APIdia, the JavaDoc alternative

Interface Summary

Modifier and Type	Interface and Description
public interface	IonBinaryWriter Deprecated Use `IonSystem#newBinaryWriter(OutputStream, SymbolTable...)` instead. An `IonWriter` that encodes Ion binary data.
public interface	IonBlob An Ion `blob` value.
public interface	IonBool An Ion `bool` value.
public interface	IonCatalog Collects shared symbol tables for use by an `IonSystem`.
public interface	IonClob An Ion `clob` value.
public interface	IonContainer Common functionality of Ion `struct`, `list`, and `sexp` types.
public interface	IonCursor A cursor over a stream of Ion data.
public interface	IonDatagram A datagram is a "top-level" container of Ion values, and the granularity of binary encoding Ion content.
public interface	IonDecimal An Ion `decimal` value.
public interface	IonFloat An Ion `float` value.
public interface	IonInt An Ion `int` value.
public interface	IonList An Ion `list` value.
public interface	IonLoader Loads Ion data in the form of datagrams.
public interface	IonLob Common functionality of Ion `blob` and `clob` types.
public interface	IonMutableCatalog An `IonCatalog` that can be updated.
public interface	IonNull The Ion `null` value, also known as `null.null`.
public interface	IonNumber Common functionality of Ion `int`, `decimal`, and `float` types.
public interface	IonReader Provides stream-based access to Ion data independent of its underlying representation (text, binary, or `IonValue` tree).
public interface	IonSequence Common functionality of Ion `list` and `sexp` types.
public interface	IonSexp An Ion `sexp` (S-expression) value.
public interface	IonString An Ion `string` value.
public interface	IonStruct An Ion `struct` value.
public interface	IonSymbol An Ion `symbol` value.
public interface	IonSystem Entry point to all things Ion.
public interface	IonText Common functionality of Ion `string` and `symbol` types.
public interface	IonTextReader Deprecated Use `TextSpan` instead. Extends `IonReader` with capabilites specialized to Ion text data streams.
public interface	IonTimestamp An Ion `timestamp` value.
public interface	IonValue Base type for all Ion data nodes.
public interface	IonWriter Writes Ion data to an output source.
public interface	IvmNotificationConsumer
public interface	OffsetSpan Exposes the positions of a `Span` in the form of zero-based offsets within the source.
public interface	RawValueSpanProvider Deprecated This is a private API subject to change without notice. Provide the ability to retrieve `Span`s (abstract value positions) of raw Ion values, excluding type and length octets.
public interface	SeekableReader An `IonReader` facet providing the ability to retrieve `Span`s (abstract value positions) and seek to positions within the source.
public interface	Span An immutable reference to a consecutive sequence of values (perhaps including large hierarchies) within some base source of Ion data.
public interface	SpanProvider Provide the ability to retrieve `Span`s (abstract value positions) of Ion data.
public interface	SymbolTable A symbol table maps symbols between their textual form and an integer ID used in the binary encoding.
public interface	SymbolToken An Ion symbol token (field name, annotation, and symbol values) providing both the symbol text and the assigned symbol ID. Symbol tokens may be interned into a `SymbolTable`.
public interface	TextSpan Exposes the positions of a `Span` in the form of one-based line and column numbers within the source text stream.
public interface	ValueFactory The factory for all `IonValue`s.
public interface	ValueVisitor A Visitor for the Ion value hierarchy.

Class Summary

Modifier and Type	Class and Description
public abstract class	BufferConfiguration< the type of the concrete subclass of this BufferConfiguration. Configuration extends BufferConfiguration<Configuration>> Provides logic common to all BufferConfiguration implementations.
public class	ContainedValueException An error caused by adding an `IonValue` into a container when it's already contained elsewhere.
public class	Decimal An extension of `BigDecimal` that can represent negative zeros.
public class	EmptySymbolException Deprecated this exception is not used as empty symbols are valid. An error caused by a symbol not containing at least one character for its text.
public class	InvalidSystemSymbolException An error caused by use of an invalid symbol starting with `"$ion_"`.
public class	IonBufferConfiguration Configures buffers that hold Ion data.
public class	IonException Base class for exceptions thrown throughout this library.
public class	NullValueException An error caused by invoking an inappropriate method on an Ion `null` value.
public class	OversizedValueException An error thrown when the user requests an IonReader to parse a scalar value that exceeds the reader's configured maximum buffer size.
public class	ReadOnlyValueException An error caused by an attempt to modify a read-only component.
public class	SubstituteSymbolTableException An error caused by an operation that requires an exact match on an import within the catalog.
public class	SystemSymbols Constants for symbols defined by the Ion specification.
public class	Timestamp An immutable representation of a point in time.
public class	UnexpectedEofException An error caused by processing an Ion input stream that ends in the middle of a value.
public class	UnknownSymbolException An error caused by a symbol ID that could not be translated into text because it is not defined by the symbol table in context.
public class	UnsupportedIonVersionException An error caused by a request for an Ion version that is not supported by this implementation.

Modifier and Type	Enum and Description
public enum	IntegerSize Indicates the smallest-possible Java type of an Ion `int` value.
public enum	IonType Enumeration identifying the core Ion data types.

Package com.amazon.ion

Interface Summary

Class Summary

Enum Summary