Ion Java 1.11.10 · com.amazon.ion.system.IonWriterBuilderBase

Modifier and Type	Field and Description
private IonCatalog	myCatalog
private SymbolTable[]	myImports

Access	Constructor and Description
protected	IonWriterBuilderBase() NOT FOR APPLICATION USE!
protected	IonWriterBuilderBase(IonWriterBuilderBase<T extends IonWriterBuilderBase> that) NOT FOR APPLICATION USE!

Method Summary

Modifier and Type	Method and Description
pack-priv abstract T	Returns: a new builder with the same configuration as `this`. copy() Creates a mutable copy of this builder.
public final IonCatalog	getCatalog() Gets the catalog to use when building an `IonWriter`.
public final SymbolTable[]	Returns: may be null or empty. getImports() Gets the imports that will be used to construct the initial local symbol table.
pack-priv abstract T	Returns: this instance, if immutable; otherwise an immutable copy of this instance. immutable() Returns an immutable builder configured exactly like this one.
pack-priv abstract T	Returns: this instance, if mutable; otherwise a mutable copy of this instance. mutable() Returns a mutable builder configured exactly like this one.
protected void	mutationCheck() NOT FOR APPLICATION USE!
private static SymbolTable[]	safeCopy(SymbolTable[] imports)
public void	setCatalog(IonCatalog the catalog to use in built writers. If null, the writer will be unable to resolve manually-written imports and may throw an exception. catalog) Sets the catalog to use when building an `IonWriter`.
public void	setImports(SymbolTable... a sequence of shared symbol tables. The first (and only the first) may be a system table. imports) Sets the shared symbol tables that will be used to construct the initial local symbol table.
public T	Returns: this instance, if mutable; otherwise a mutable copy of this instance. withCatalog(IonCatalog the catalog to use in built writers. If null, the writer will be unable to resolve manually-written imports and may throw an exception. catalog) Declares the catalog to use when building an `IonWriter`, returning a new mutable builder if this is immutable.
public T	Returns: this instance, if mutable; otherwise a mutable copy of this instance. withImports(SymbolTable... a sequence of shared symbol tables. The first (and only the first) may be a system table. imports) Declares the imports to use when building an `IonWriter`, returning a new mutable builder if this is immutable.

Inherited from com.amazon.ion.system.IonWriterBuilder:: build getInitialIvmHandling getIvmMinimizing

myCatalog	back to summary
private IonCatalog myCatalog

myImports	back to summary
private SymbolTable[] myImports

IonWriterBuilderBase	back to summary
protected IonWriterBuilderBase() NOT FOR APPLICATION USE!

IonWriterBuilderBase	back to summary
protected IonWriterBuilderBase(IonWriterBuilderBase<T extends IonWriterBuilderBase> that) NOT FOR APPLICATION USE!

Method Detail

copy back to summary

copy	back to summary
pack-priv abstract T copy() Creates a mutable copy of this builder. Returns:T a new builder with the same configuration as `this`.

pack-priv abstract T copy()

Creates a mutable copy of this builder.

Returns:T: a new builder with the same configuration as this.

getCatalog back to summary

getCatalog	back to summary
public final IonCatalog getCatalog() Gets the catalog to use when building an `IonWriter`. The catalog is needed to resolve manually-written imports (not common). By default, this property is null. See Also `setCatalog(IonCatalog)`, `withCatalog(IonCatalog)`

public final IonCatalog getCatalog()

Gets the catalog to use when building an IonWriter. The catalog is needed to resolve manually-written imports (not common). By default, this property is null.

See Also: setCatalog(IonCatalog), withCatalog(IonCatalog)

getImports back to summary

getImports	back to summary
public final SymbolTable[] getImports() Gets the imports that will be used to construct the initial local symbol table. Returns:SymbolTable[] may be null or empty. See Also `setImports(SymbolTable...)`, `withImports(SymbolTable...)`

public final SymbolTable[] getImports()

Gets the imports that will be used to construct the initial local symbol table.

Returns:SymbolTable[]: may be null or empty.
See Also: setImports(SymbolTable...), withImports(SymbolTable...)

immutable	back to summary
pack-priv abstract T immutable() Returns an immutable builder configured exactly like this one. Returns:T this instance, if immutable; otherwise an immutable copy of this instance.

immutable

back to summary

pack-priv abstract T immutable()

Returns an immutable builder configured exactly like this one.

Returns:T: this instance, if immutable; otherwise an immutable copy of this instance.

mutable	back to summary
pack-priv abstract T mutable() Returns a mutable builder configured exactly like this one. Returns:T this instance, if mutable; otherwise a mutable copy of this instance.

mutable

back to summary

pack-priv abstract T mutable()

Returns a mutable builder configured exactly like this one.

Returns:T: this instance, if mutable; otherwise a mutable copy of this instance.

mutationCheck	back to summary
protected void mutationCheck() NOT FOR APPLICATION USE!

safeCopy	back to summary
private static SymbolTable[] safeCopy(SymbolTable[] imports)

setCatalog back to summary

setCatalog	back to summary
public void setCatalog(IonCatalog catalog) Sets the catalog to use when building an `IonWriter`. Parameters catalog:IonCatalog the catalog to use in built writers. If null, the writer will be unable to resolve manually-written imports and may throw an exception. Exceptions UnsupportedOperationException: if this is immutable. See Also `getCatalog()`, `withCatalog(IonCatalog)`

public void setCatalog(IonCatalog catalog)

Sets the catalog to use when building an IonWriter.

Parameters

catalog:IonCatalog: the catalog to use in built writers. If null, the writer will be unable to resolve manually-written imports and may throw an exception.

Exceptions

UnsupportedOperationException:: if this is immutable.

setImports back to summary

setImports	back to summary
public void setImports(SymbolTable... imports) Sets the shared symbol tables that will be used to construct the initial local symbol table. If the imports sequence is not null and not empty, the output stream will be bootstrapped with a local symbol table that uses the given `imports`. Parameters imports:SymbolTable[] a sequence of shared symbol tables. The first (and only the first) may be a system table. Exceptions UnsupportedOperationException: if this is immutable. See Also `getImports()`, `withImports(SymbolTable...)`

public void setImports(SymbolTable... imports)

Sets the shared symbol tables that will be used to construct the initial local symbol table.

If the imports sequence is not null and not empty, the output stream will be bootstrapped with a local symbol table that uses the given imports.

Parameters

imports:SymbolTable[]: a sequence of shared symbol tables. The first (and only the first) may be a system table.

Exceptions

UnsupportedOperationException:: if this is immutable.

withCatalog back to summary

withCatalog	back to summary
public T withCatalog(IonCatalog catalog) Declares the catalog to use when building an `IonWriter`, returning a new mutable builder if this is immutable. Parameters catalog:IonCatalog the catalog to use in built writers. If null, the writer will be unable to resolve manually-written imports and may throw an exception. Returns:T this instance, if mutable; otherwise a mutable copy of this instance. See Also `getCatalog()`, `setCatalog(IonCatalog)`

public T withCatalog(IonCatalog catalog)

Declares the catalog to use when building an IonWriter, returning a new mutable builder if this is immutable.

Parameters

catalog:IonCatalog: the catalog to use in built writers. If null, the writer will be unable to resolve manually-written imports and may throw an exception.

Returns:T

this instance, if mutable; otherwise a mutable copy of this instance.

withImports back to summary

withImports	back to summary
public T withImports(SymbolTable... imports) Declares the imports to use when building an `IonWriter`, returning a new mutable builder if this is immutable. If the imports sequence is not null and not empty, the output stream will be bootstrapped with a local symbol table that uses the given `imports`. Parameters imports:SymbolTable[] a sequence of shared symbol tables. The first (and only the first) may be a system table. Returns:T this instance, if mutable; otherwise a mutable copy of this instance. See Also `getImports()`, `setImports(SymbolTable...)`

public T withImports(SymbolTable... imports)

Declares the imports to use when building an IonWriter, returning a new mutable builder if this is immutable.

If the imports sequence is not null and not empty, the output stream will be bootstrapped with a local symbol table that uses the given imports.

Parameters

imports:SymbolTable[]: a sequence of shared symbol tables. The first (and only the first) may be a system table.

Returns:T

this instance, if mutable; otherwise a mutable copy of this instance.

pack-priv abstract Class IonWriterBuilderBase<T extends IonWriterBuilderBase>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail