com.amazon.ion

Class BufferConfiguration<Configuration extends BufferConfiguration<Configuration>>

java.lang.Object

com.amazon.ion.BufferConfiguration<Configuration>

Type Parameters:

Configuration - the type of the concrete subclass of this BufferConfiguration.

Direct Known Subclasses:

IonBufferConfiguration

public abstract class BufferConfiguration<Configuration extends BufferConfiguration<Configuration>>
extends java.lang.Object

Provides logic common to all BufferConfiguration implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BufferConfiguration.Builder<Configuration extends BufferConfiguration<Configuration>,BuilderType extends BufferConfiguration.Builder<Configuration,BuilderType>> Provides logic common to all BufferConfiguration Builder implementations.
static interface	BufferConfiguration.DataHandler Functional interface for reporting processed data.
static interface	BufferConfiguration.OversizedValueHandler Functional interface for handling oversized values.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BufferConfiguration(BufferConfiguration.Builder<Configuration,?> builder) Constructs an instance from the given Builder.

Method Summary

Modifier and Type	Method and Description
BufferConfiguration.DataHandler	getDataHandler()
int	getInitialBufferSize()
int	getMaximumBufferSize()
BufferConfiguration.OversizedValueHandler	getOversizedValueHandler()
protected void	requireMaximumBufferSize() Requires that the maximum buffer size not be limited.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BufferConfiguration

protected BufferConfiguration(BufferConfiguration.Builder<Configuration,?> builder)

Constructs an instance from the given Builder.

Parameters:

builder - the builder containing the settings to apply to the new configuration.

Method Detail

requireMaximumBufferSize

protected void requireMaximumBufferSize()

Requires that the maximum buffer size not be limited.

getInitialBufferSize

public final int getInitialBufferSize()

Returns:

the initial size of the buffer, in bytes.

getMaximumBufferSize

public final int getMaximumBufferSize()

Returns:

the maximum number of bytes that will be buffered.

getOversizedValueHandler

public final BufferConfiguration.OversizedValueHandler getOversizedValueHandler()

Returns:

the handler that will be notified when oversized values are encountered.

getDataHandler

public final BufferConfiguration.DataHandler getDataHandler()

Returns:

the handler that will be notified when data is processed.