Modifier and Type	Class and Description
public static class	IonBufferConfiguration.Builder Builds IonBufferConfiguration instances.
public static interface	IonBufferConfiguration.OversizedSymbolTableHandler Functional interface for handling oversized symbol tables.

Modifier and Type	Field and Description
public static final IonBufferConfiguration	DEFAULT The standard configuration.
private final IonBufferConfiguration.OversizedSymbolTableHandler	oversizedSymbolTableHandler The handler that will be notified when oversized symbol tables are encountered.

Access	Constructor and Description
private	IonBufferConfiguration(IonBufferConfiguration.Builder the builder containing the settings to apply to the new configuration. builder) Constructs an instance from the given Builder.

Modifier and Type	Method and Description
public IonBufferConfiguration.OversizedSymbolTableHandler	Returns: the handler that will be notified when oversized symbol tables are encountered. getOversizedSymbolTableHandler()

DEFAULT	back to summary
public static final IonBufferConfiguration DEFAULT The standard configuration. This will be used unless the user chooses custom settings.

oversizedSymbolTableHandler	back to summary
private final IonBufferConfiguration.OversizedSymbolTableHandler oversizedSymbolTableHandler The handler that will be notified when oversized symbol tables are encountered.

IonBufferConfiguration	back to summary
private IonBufferConfiguration(IonBufferConfiguration.Builder builder) Constructs an instance from the given Builder. Parameters builder:IonBufferConfiguration.Builder the builder containing the settings to apply to the new configuration.

getOversizedSymbolTableHandler	back to summary
public IonBufferConfiguration.OversizedSymbolTableHandler getOversizedSymbolTableHandler() Returns:IonBufferConfiguration.OversizedSymbolTableHandler the handler that will be notified when oversized symbol tables are encountered.

public final Class IonBufferConfiguration.Builder

Class Inheritance

extends BufferConfiguration.Builder<IonBufferConfiguration, IonBufferConfiguration.Builder>

java.lang.Object
com.amazon.ion.BufferConfiguration.Builder
com.amazon.ion.IonBufferConfiguration.Builder

Builds IonBufferConfiguration instances.

Field Summary

Modifier and Type	Field and Description
private static final int	MINIMUM_MAX_VALUE_SIZE 4-byte IVM + 1 byte user value.
private static final BufferConfiguration.DataHandler	NO_OP_DATA_HANDLER A DataHandler that does nothing.
private static final IonBufferConfiguration.OversizedSymbolTableHandler	NO_OP_OVERSIZED_SYMBOL_TABLE_HANDLER An OversizedSymbolTableHandler that does nothing.
private static final BufferConfiguration.OversizedValueHandler	NO_OP_OVERSIZED_VALUE_HANDLER An OversizedValueHandler that does nothing.
private IonBufferConfiguration.OversizedSymbolTableHandler	oversizedSymbolTableHandler The handler that will be notified when oversized symbol tables are encountered.
private static final IonBufferConfiguration.OversizedSymbolTableHandler	THROWING_OVERSIZED_SYMBOL_TABLE_HANDLER
private static final BufferConfiguration.OversizedValueHandler	THROWING_OVERSIZED_VALUE_HANDLER

Inherited from com.amazon.ion.BufferConfiguration.Builder:: DEFAULT_INITIAL_BUFFER_SIZE

Constructor Summary

Access	Constructor and Description
private	Builder()

Method Summary

Modifier and Type	Method and Description
public IonBufferConfiguration	build() Implements abstract com.amazon.ion.BufferConfiguration.Builder.build. Creates a new BufferConfiguration from the Builder's current settings.
public static IonBufferConfiguration.Builder	Returns: a new mutable builder. from(IonBufferConfiguration an existing configuration. existingConfiguration) Provides a new builder that would build IonBufferConfiguration instances with configuration identical to the given configuration.
public int	getMinimumMaximumBufferSize() Implements abstract com.amazon.ion.BufferConfiguration.Builder.getMinimumMaximumBufferSize. Gets the minimum allowed maximum buffer size.
public BufferConfiguration.DataHandler	getNoOpDataHandler() Implements abstract com.amazon.ion.BufferConfiguration.Builder.getNoOpDataHandler.
public IonBufferConfiguration.OversizedSymbolTableHandler	Returns: an OversizedSymbolTableHandler that does nothing. getNoOpOversizedSymbolTableHandler()
public BufferConfiguration.OversizedValueHandler	getNoOpOversizedValueHandler() Implements abstract com.amazon.ion.BufferConfiguration.Builder.getNoOpOversizedValueHandler.
public IonBufferConfiguration.OversizedSymbolTableHandler	Returns: the handler that will be notified when oversized symbol tables are encountered. getOversizedSymbolTableHandler()
public IonBufferConfiguration.OversizedSymbolTableHandler	Returns: an OversizedSymbolTableHandler that always throws `IonException`. getThrowingOversizedSymbolTableHandler()
public BufferConfiguration.OversizedValueHandler	getThrowingOversizedValueHandler() Implements abstract com.amazon.ion.BufferConfiguration.Builder.getThrowingOversizedValueHandler.
public IonBufferConfiguration.Builder	Returns: this builder. onOversizedSymbolTable(IonBufferConfiguration.OversizedSymbolTableHandler the handler. handler) Sets the handler that will be notified when oversized symbol tables are encountered.
public static IonBufferConfiguration.Builder	Returns: a standard Builder. standard() Provides the standard builder with the default initial buffer size, an unbounded maximum buffer size, and an event handler that does nothing.
private static void	throwDueToUnexpectedOversizedValue()

Inherited from com.amazon.ion.BufferConfiguration.Builder:: getDataHandler getInitialBufferSize getMaximumBufferSize getOversizedValueHandler onData onOversizedValue withInitialBufferSize withMaximumBufferSize

Field Detail

MINIMUM_MAX_VALUE_SIZE	back to summary
private static final int MINIMUM_MAX_VALUE_SIZE 4-byte IVM + 1 byte user value.

NO_OP_DATA_HANDLER	back to summary
private static final BufferConfiguration.DataHandler NO_OP_DATA_HANDLER A DataHandler that does nothing.

NO_OP_OVERSIZED_SYMBOL_TABLE_HANDLER	back to summary
private static final IonBufferConfiguration.OversizedSymbolTableHandler NO_OP_OVERSIZED_SYMBOL_TABLE_HANDLER An OversizedSymbolTableHandler that does nothing.

NO_OP_OVERSIZED_VALUE_HANDLER	back to summary
private static final BufferConfiguration.OversizedValueHandler NO_OP_OVERSIZED_VALUE_HANDLER An OversizedValueHandler that does nothing.

oversizedSymbolTableHandler	back to summary
private IonBufferConfiguration.OversizedSymbolTableHandler oversizedSymbolTableHandler The handler that will be notified when oversized symbol tables are encountered.

THROWING_OVERSIZED_SYMBOL_TABLE_HANDLER	back to summary
private static final IonBufferConfiguration.OversizedSymbolTableHandler THROWING_OVERSIZED_SYMBOL_TABLE_HANDLER

THROWING_OVERSIZED_VALUE_HANDLER	back to summary
private static final BufferConfiguration.OversizedValueHandler THROWING_OVERSIZED_VALUE_HANDLER

Constructor Detail

Builder	back to summary
private Builder()

Method Detail

build	back to summary
public IonBufferConfiguration build() Implements abstract com.amazon.ion.BufferConfiguration.Builder.build. Doc from com.amazon.ion.BufferConfiguration.Builder.build. Creates a new BufferConfiguration from the Builder's current settings. Returns:IonBufferConfiguration a new instance. Annotations @Override

build

back to summary

public IonBufferConfiguration build()

Implements abstract com.amazon.ion.BufferConfiguration.Builder.build.

Doc from com.amazon.ion.BufferConfiguration.Builder.build.

Creates a new BufferConfiguration from the Builder's current settings.

Returns:IonBufferConfiguration

a new instance.

Annotations

@Override

from	back to summary
public static IonBufferConfiguration.Builder from(IonBufferConfiguration existingConfiguration) Provides a new builder that would build IonBufferConfiguration instances with configuration identical to the given configuration. Parameters existingConfiguration:IonBufferConfiguration an existing configuration. Returns:IonBufferConfiguration.Builder a new mutable builder.

from

back to summary

public static IonBufferConfiguration.Builder from(IonBufferConfiguration existingConfiguration)

Provides a new builder that would build IonBufferConfiguration instances with configuration identical to the given configuration.

Parameters

existingConfiguration:IonBufferConfiguration: an existing configuration.

Returns:IonBufferConfiguration.Builder

a new mutable builder.

getMinimumMaximumBufferSize	back to summary
public int getMinimumMaximumBufferSize() Implements abstract com.amazon.ion.BufferConfiguration.Builder.getMinimumMaximumBufferSize. Doc from com.amazon.ion.BufferConfiguration.Builder.getMinimumMaximumBufferSize. Gets the minimum allowed maximum buffer size. Returns:int the value. Annotations @Override

getMinimumMaximumBufferSize

back to summary

public int getMinimumMaximumBufferSize()

Implements abstract com.amazon.ion.BufferConfiguration.Builder.getMinimumMaximumBufferSize.

Doc from com.amazon.ion.BufferConfiguration.Builder.getMinimumMaximumBufferSize.

Gets the minimum allowed maximum buffer size.

Returns:int

the value.

Annotations

@Override

getNoOpDataHandler back to summary

getNoOpDataHandler	back to summary
public BufferConfiguration.DataHandler getNoOpDataHandler() Implements abstract com.amazon.ion.BufferConfiguration.Builder.getNoOpDataHandler. Returns:BufferConfiguration.DataHandler Doc from com.amazon.ion.BufferConfiguration.Builder.getNoOpDataHandler. the no-op `DataHandler` for the type of BufferConfiguration that this Builder builds. Annotations @Override

public BufferConfiguration.DataHandler getNoOpDataHandler()

Implements abstract com.amazon.ion.BufferConfiguration.Builder.getNoOpDataHandler.

Returns:BufferConfiguration.DataHandler

Doc from com.amazon.ion.BufferConfiguration.Builder.getNoOpDataHandler.

the no-op DataHandler for the type of BufferConfiguration that this Builder builds.

Annotations

@Override

getNoOpOversizedSymbolTableHandler	back to summary
public IonBufferConfiguration.OversizedSymbolTableHandler getNoOpOversizedSymbolTableHandler() Returns:IonBufferConfiguration.OversizedSymbolTableHandler an OversizedSymbolTableHandler that does nothing.

getNoOpOversizedValueHandler back to summary

getNoOpOversizedValueHandler	back to summary
public BufferConfiguration.OversizedValueHandler getNoOpOversizedValueHandler() Implements abstract com.amazon.ion.BufferConfiguration.Builder.getNoOpOversizedValueHandler. Returns:BufferConfiguration.OversizedValueHandler Doc from com.amazon.ion.BufferConfiguration.Builder.getNoOpOversizedValueHandler. the no-op `OversizedValueHandler` for the type of BufferConfiguration that this Builder builds. Annotations @Override

public BufferConfiguration.OversizedValueHandler getNoOpOversizedValueHandler()

Implements abstract com.amazon.ion.BufferConfiguration.Builder.getNoOpOversizedValueHandler.

Returns:BufferConfiguration.OversizedValueHandler

Doc from com.amazon.ion.BufferConfiguration.Builder.getNoOpOversizedValueHandler.

the no-op OversizedValueHandler for the type of BufferConfiguration that this Builder builds.

Annotations

@Override

getOversizedSymbolTableHandler	back to summary
public IonBufferConfiguration.OversizedSymbolTableHandler getOversizedSymbolTableHandler() Returns:IonBufferConfiguration.OversizedSymbolTableHandler the handler that will be notified when oversized symbol tables are encountered.

getThrowingOversizedSymbolTableHandler	back to summary
public IonBufferConfiguration.OversizedSymbolTableHandler getThrowingOversizedSymbolTableHandler() Returns:IonBufferConfiguration.OversizedSymbolTableHandler an OversizedSymbolTableHandler that always throws `IonException`.

getThrowingOversizedValueHandler back to summary

getThrowingOversizedValueHandler	back to summary
public BufferConfiguration.OversizedValueHandler getThrowingOversizedValueHandler() Implements abstract com.amazon.ion.BufferConfiguration.Builder.getThrowingOversizedValueHandler. Returns:BufferConfiguration.OversizedValueHandler Doc from com.amazon.ion.BufferConfiguration.Builder.getThrowingOversizedValueHandler. an `OversizedValueHandler` that always throws a runtime exception. Annotations @Override

public BufferConfiguration.OversizedValueHandler getThrowingOversizedValueHandler()

Implements abstract com.amazon.ion.BufferConfiguration.Builder.getThrowingOversizedValueHandler.

Returns:BufferConfiguration.OversizedValueHandler

Doc from com.amazon.ion.BufferConfiguration.Builder.getThrowingOversizedValueHandler.

an OversizedValueHandler that always throws a runtime exception.

Annotations

@Override

onOversizedSymbolTable back to summary

onOversizedSymbolTable	back to summary
public IonBufferConfiguration.Builder onOversizedSymbolTable(IonBufferConfiguration.OversizedSymbolTableHandler handler) Sets the handler that will be notified when oversized symbol tables are encountered. If the maximum buffer size is finite (see `withMaximumBufferSize(int)`, this handler is required to be non-null. Parameters handler:IonBufferConfiguration.OversizedSymbolTableHandler the handler. Returns:IonBufferConfiguration.Builder this builder.

public IonBufferConfiguration.Builder onOversizedSymbolTable(IonBufferConfiguration.OversizedSymbolTableHandler handler)

Sets the handler that will be notified when oversized symbol tables are encountered. If the maximum buffer size is finite (see withMaximumBufferSize(int), this handler is required to be non-null.

Parameters

handler:IonBufferConfiguration.OversizedSymbolTableHandler: the handler.

Returns:IonBufferConfiguration.Builder

this builder.

standard	back to summary
public static IonBufferConfiguration.Builder standard() Provides the standard builder with the default initial buffer size, an unbounded maximum buffer size, and an event handler that does nothing. Returns:IonBufferConfiguration.Builder a standard Builder.

standard

back to summary

public static IonBufferConfiguration.Builder standard()

Provides the standard builder with the default initial buffer size, an unbounded maximum buffer size, and an event handler that does nothing.

Returns:IonBufferConfiguration.Builder: a standard Builder.

throwDueToUnexpectedOversizedValue	back to summary
private static void throwDueToUnexpectedOversizedValue()

public final Class IonBufferConfiguration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class IonBufferConfiguration.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface IonBufferConfiguration.OversizedSymbolTableHandler

Method Summary

Method Detail