Package com.amazon.ion.system

Class IonWriterBuilder

java.lang.Object

com.amazon.ion.system.IonWriterBuilder

Direct Known Subclasses:

IonBinaryWriterBuilder, IonTextWriterBuilder

public abstract class IonWriterBuilder
extends Object

Common options for writing Ion data streams of any form.

WARNING: This class should not be extended by code outside of this library.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	IonWriterBuilder.InitialIvmHandling	A strategy for altering emission of Ion version markers at the start of an Ion stream.
static enum	IonWriterBuilder.IvmMinimizing	A strategy for minimizing the output of non-initial Ion version markers.

Method Summary

Modifier and Type	Method	Description
abstract IonWriter	build(OutputStream out)	Builds a new writer based on this builder's configuration properties.
abstract IonWriterBuilder.InitialIvmHandling	getInitialIvmHandling()	Gets the strategy for emitting Ion version markers at the start of the stream.
abstract IonWriterBuilder.IvmMinimizing	getIvmMinimizing()	Gets the strategy for eliminating Ion version markers mid-stream.

Methods inherited from class java.lang.Object

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

Method Details

getInitialIvmHandling

public abstract IonWriterBuilder.InitialIvmHandling getInitialIvmHandling()

Gets the strategy for emitting Ion version markers at the start of the stream. By default, IVMs are emitted only when explicitly written or when necessary (for example, before data that's not Ion 1.0, or at the start of Ion binary output).

Returns:

the initial IVM strategy. Null indicates the default for the specific output form.

getIvmMinimizing

public abstract IonWriterBuilder.IvmMinimizing getIvmMinimizing()

Gets the strategy for eliminating Ion version markers mid-stream. By default, IVMs are emitted as received or when necessary.

This strategy does not affect handling of IVMs at the start of the stream; that's the job of IonWriterBuilder.InitialIvmHandling.

Returns:

the IVM minimizing strategy.

build

public abstract IonWriter build(OutputStream out)

Builds a new writer based on this builder's configuration properties.

Parameters:

out - the stream that will receive Ion data. Must not be null.

Returns:

a new IonWriter instance; not null.