_Private_IonBinaryWriterBuilder (ion-java 1.11.9 API)

java.lang.Object
- com.amazon.ion.system.IonWriterBuilder
- - com.amazon.ion.system.IonBinaryWriterBuilder
  - - com.amazon.ion.impl._Private_IonBinaryWriterBuilder

public class _Private_IonBinaryWriterBuilder
extends IonBinaryWriterBuilder

NOT FOR APPLICATION USE!

Nested Class Summary
- Nested classes/interfaces inherited from class com.amazon.ion.system.IonWriterBuilder
  IonWriterBuilder.InitialIvmHandling, IonWriterBuilder.IvmMinimizing

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`IonWriter`	`build(java.io.OutputStream out)` Builds a new writer based on this builder's configuration properties.
`IonBinaryWriter`	`buildLegacy()` Deprecated.
`_Private_IonBinaryWriterBuilder`	`copy()` Creates a mutable copy of this builder.
`IonCatalog`	`getCatalog()` Gets the catalog to use when building an `IonWriter`.
`SymbolTable[]`	`getImports()` Gets the imports that will be used to construct the initial local symbol table.
`SymbolTable`	`getInitialSymbolTable()` Gets the symbol table to use for encoded data.
`ValueFactory`	`getSymtabValueFactory()`
`_Private_IonBinaryWriterBuilder`	`immutable()` Returns an immutable builder configured exactly like this one.
`_Private_IonBinaryWriterBuilder`	`mutable()` Returns a mutable builder configured exactly like this one.
`protected void`	`mutationCheck()` NOT FOR APPLICATION USE!
`void`	`setAutoFlushEnabled(boolean autoFlushEnabled)`
`void`	`setBlockSize(int size)`
`void`	`setCatalog(IonCatalog catalog)` Sets the catalog to use when building an `IonWriter`.
`void`	`setImports(SymbolTable... imports)` Sets the shared symbol tables that will be used to construct the initial local symbol table.
`void`	`setInitialSymbolTable(SymbolTable symtab)` Declares the symbol table to use for encoded data.
`void`	`setIsFloatBinary32Enabled(boolean enabled)` Enables or disables writing Binary32 (4-byte, single precision, IEEE-754) values for floats when there would be no loss in precision.
`void`	`setLocalSymbolTableAppendEnabled(boolean enabled)` Enables or disables writing local symbol tables that append symbols to the current symbol table.
`void`	`setStreamCopyOptimized(boolean optimized)` Declares whether built writers may attempt to optimize `IonWriter.writeValue(IonReader)` by copying raw source data.
`void`	`setSymtabValueFactory(ValueFactory factory)`
`static _Private_IonBinaryWriterBuilder`	`standard()`
`_Private_IonBinaryWriterBuilder`	`withAutoFlushEnabled(boolean autoFlushEnabled)` Auto-flush enables automatic execution of flush operations during the write process.
`_Private_IonBinaryWriterBuilder`	`withBlockSize(int size)` Specify the block size for write buffer.
`_Private_IonBinaryWriterBuilder`	`withFloatBinary32Disabled()` Disables writing Binary32 (4-byte, single precision, IEEE-754) values for floats.
`_Private_IonBinaryWriterBuilder`	`withFloatBinary32Enabled()` Enables writing Binary32 (4-byte, single precision, IEEE-754) values for floats when there would be no loss in precision.
`_Private_IonBinaryWriterBuilder`	`withInitialSymbolTable(SymbolTable symtab)` Defaults to $ion_1_0 if null.
`_Private_IonBinaryWriterBuilder`	`withLocalSymbolTableAppendDisabled()` Disables writing local symbol tables that append symbols to the current symbol table.
`_Private_IonBinaryWriterBuilder`	`withLocalSymbolTableAppendEnabled()` Enables writing local symbol tables that append symbols to the current symbol table.
`_Private_IonBinaryWriterBuilder`	`withSymtabValueFactory(ValueFactory factory)`

Methods inherited from class com.amazon.ion.system.IonBinaryWriterBuilder
getInitialIvmHandling, getIvmMinimizing, isStreamCopyOptimized, withCatalog, withImports, withStreamCopyOptimized

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - standard
```
public static _Private_IonBinaryWriterBuilder standard()
```
    Returns:
    
    a new mutable builder.
  - copy
```
public final _Private_IonBinaryWriterBuilder copy()
```
    Creates a mutable copy of this builder.
    
    Specified by:
    
    copy in class IonBinaryWriterBuilder
    
    Returns:
    
    a new builder with the same configuration as this.
  - immutable
```
public _Private_IonBinaryWriterBuilder immutable()
```
    Returns an immutable builder configured exactly like this one.
    
    Specified by:
    
    immutable in class IonBinaryWriterBuilder
    
    Returns:
    
    this instance, if immutable; otherwise an immutable copy of this instance.
  - mutable
```
public _Private_IonBinaryWriterBuilder mutable()
```
    Returns a mutable builder configured exactly like this one.
    
    Specified by:
    
    mutable in class IonBinaryWriterBuilder
    
    Returns:
    
    this instance, if mutable; otherwise a mutable copy of this instance.
  - getSymtabValueFactory
```
public ValueFactory getSymtabValueFactory()
```
  - setSymtabValueFactory
```
public void setSymtabValueFactory(ValueFactory factory)
```
  - withSymtabValueFactory
```
public _Private_IonBinaryWriterBuilder withSymtabValueFactory(ValueFactory factory)
```
  - getInitialSymbolTable
```
public SymbolTable getInitialSymbolTable()
```
    Description copied from class: IonBinaryWriterBuilder
    
    Gets the symbol table to use for encoded data. To avoid conflicts between different data streams, if the given instance is mutable, it will be copied when build() is called.
    
    Specified by:
    
    getInitialSymbolTable in class IonBinaryWriterBuilder
    
    Returns:
    
    a local or system symbol table. May be null, in which case the initial symbol table is that of $ion_1_0.
    
    See Also:
    
    IonBinaryWriterBuilder.setInitialSymbolTable(SymbolTable), IonBinaryWriterBuilder.withInitialSymbolTable(SymbolTable)
  - setInitialSymbolTable
```
public void setInitialSymbolTable(SymbolTable symtab)
```
    Declares the symbol table to use for encoded data. To avoid conflicts between different data streams, if the given instance is mutable, it will be copied when build() is called.
    
    Specified by:
    
    setInitialSymbolTable in class IonBinaryWriterBuilder
    
    Parameters:
    
    symtab - must be a local or system symbol table. May be null, in which case the initial symtab is that of $ion_1_0.
    
    Throws:
    
    SubstituteSymbolTableException - if any imported table is a substitute (see SymbolTable).
    
    See Also:
    
    IonBinaryWriterBuilder.getInitialSymbolTable(), IonBinaryWriterBuilder.withInitialSymbolTable(SymbolTable)
  - withInitialSymbolTable
```
public _Private_IonBinaryWriterBuilder withInitialSymbolTable(SymbolTable symtab)
```
    Defaults to $ion_1_0 if null.
    
    Specified by:
    
    withInitialSymbolTable in class IonBinaryWriterBuilder
    
    Parameters:
    
    symtab - may be null.
  - withAutoFlushEnabled
```
public _Private_IonBinaryWriterBuilder withAutoFlushEnabled(boolean autoFlushEnabled)
```
    Description copied from class: IonBinaryWriterBuilder
    
    Auto-flush enables automatic execution of flush operations during the write process. When auto-flush is enabled and a new block allocation becomes necessary while writing the top-level value, a new block will be allocated. The data writing process will then continue uninterrupted until the top-level value is complete. After completing the top-level value that crosses the block boundary, the flush operation will be executed. This feature optimizes performance of the writing of long data streams by reducing block allocations. Additionally, setting a larger block size can further tune performance when auto-flush is enabled. A larger block size leads to fewer block allocations and reduces the frequency of flush operations when auto-flush is enabled. Here is where you can set up the block size of write buffer. Auto-flush is disabled by default and the default block size is 32K.
    
    Specified by:
    
    withAutoFlushEnabled in class IonBinaryWriterBuilder
    
    Parameters:
    
    autoFlushEnabled - A boolean parameter indicating whether this functionality is enabled or not.
  - setAutoFlushEnabled
```
public void setAutoFlushEnabled(boolean autoFlushEnabled)
```
  - setLocalSymbolTableAppendEnabled
```
public void setLocalSymbolTableAppendEnabled(boolean enabled)
```
    Description copied from class: IonBinaryWriterBuilder
    
    Enables or disables writing local symbol tables that append symbols to the current symbol table. This functionality is disabled by default.
    
    Specified by:
    
    setLocalSymbolTableAppendEnabled in class IonBinaryWriterBuilder
  - withLocalSymbolTableAppendEnabled
```
public _Private_IonBinaryWriterBuilder withLocalSymbolTableAppendEnabled()
```
    Description copied from class: IonBinaryWriterBuilder
    
    Enables writing local symbol tables that append symbols to the current symbol table. This functionality is disabled by default.
    
    Specified by:
    
    withLocalSymbolTableAppendEnabled in class IonBinaryWriterBuilder
  - withLocalSymbolTableAppendDisabled
```
public _Private_IonBinaryWriterBuilder withLocalSymbolTableAppendDisabled()
```
    Description copied from class: IonBinaryWriterBuilder
    
    Disables writing local symbol tables that append symbols to the current symbol table. This functionality is disabled by default.
    
    Specified by:
    
    withLocalSymbolTableAppendDisabled in class IonBinaryWriterBuilder
  - withBlockSize
```
public _Private_IonBinaryWriterBuilder withBlockSize(int size)
```
    Description copied from class: IonBinaryWriterBuilder
    
    Specify the block size for write buffer.
    
    Specified by:
    
    withBlockSize in class IonBinaryWriterBuilder
    
    Parameters:
    
    size - represent the specified block size in bytes. If this functionality is not set, the default block size is 32768 bytes.
  - setIsFloatBinary32Enabled
```
public void setIsFloatBinary32Enabled(boolean enabled)
```
    Description copied from class: IonBinaryWriterBuilder
    
    Enables or disables writing Binary32 (4-byte, single precision, IEEE-754) values for floats when there would be no loss in precision. By default Binary32 support is disabled to ensure the broadest compatibility with existing Ion implementations. Historically, implementations were only able to read Binary64 values.
    When enabled, floats are evaluated for a possible loss of data at single precision. If the value can be represented in single precision without data loss, it is written as a 4-byte, Binary32 value. Floats which cannot be represented as single-precision values are written as 8-byte, Binary64 values (this is the legacy behavior for all floats, regardless of value).
    
    Specified by:
    
    setIsFloatBinary32Enabled in class IonBinaryWriterBuilder
    
    Parameters:
    
    enabled - true to enable writing 4-byte floats, false to always write 8-byte floats.
    
    See Also:
    
    IonBinaryWriterBuilder.withFloatBinary32Enabled(), IonBinaryWriterBuilder.withFloatBinary32Disabled()
  - withFloatBinary32Enabled
```
public _Private_IonBinaryWriterBuilder withFloatBinary32Enabled()
```
    Description copied from class: IonBinaryWriterBuilder
    
    Enables writing Binary32 (4-byte, single precision, IEEE-754) values for floats when there would be no loss in precision. By default Binary32 support is disabled to ensure the broadest compatibility with existing Ion implementations. Historically, implementations were only able to read Binary64 values.
    When enabled, floats are evaluated for a possible loss of data at single precision. If the value can be represented in single precision without data loss, it is written as a 4-byte, Binary32 value. Floats which cannot be represented as single-precision values are written as 8-byte, Binary64 values (this is the legacy behavior for all floats, regardless of value).
    
    Specified by:
    
    withFloatBinary32Enabled in class IonBinaryWriterBuilder
    
    See Also:
    
    IonBinaryWriterBuilder.setIsFloatBinary32Enabled(boolean), IonBinaryWriterBuilder.withFloatBinary32Disabled()
  - withFloatBinary32Disabled
```
public _Private_IonBinaryWriterBuilder withFloatBinary32Disabled()
```
    Description copied from class: IonBinaryWriterBuilder
    
    Disables writing Binary32 (4-byte, single precision, IEEE-754) values for floats. This is the default behavior.
    When disabled, floats are always written as 8-byte, Binary64 values regardless of value. This is the legacy behavior for all Ion binary writers and ensures the boarded compatibility with other Ion consumers.
    
    Specified by:
    
    withFloatBinary32Disabled in class IonBinaryWriterBuilder
    
    See Also:
    
    IonBinaryWriterBuilder.setIsFloatBinary32Enabled(boolean), IonBinaryWriterBuilder.withFloatBinary32Enabled()
  - setImports
```
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 - a sequence of shared symbol tables. The first (and only the first) may be a system table.
    
    See Also:
    
    getImports(), withImports(SymbolTable...)
  - setCatalog
```
public void setCatalog(IonCatalog catalog)
```
    Sets the catalog to use when building an IonWriter.
    
    Parameters:
    
    catalog - the catalog to use in built writers. If null, the writer will be unable to resolve manually-written imports and may throw an exception.
    
    See Also:
    
    getCatalog(), withCatalog(IonCatalog)
  - setStreamCopyOptimized
```
public void setStreamCopyOptimized(boolean optimized)
```
    Description copied from class: IonBinaryWriterBuilder
    
    Declares whether built writers may attempt to optimize IonWriter.writeValue(IonReader) by copying raw source data. By default, this property is false.
    This feature is experimental! Please test thoroughly and report any issues.
    
    Overrides:
    
    setStreamCopyOptimized in class IonBinaryWriterBuilder
    
    See Also:
    
    IonBinaryWriterBuilder.isStreamCopyOptimized(), IonBinaryWriterBuilder.withStreamCopyOptimized(boolean)
  - setBlockSize
```
public void setBlockSize(int size)
```
  - build
```
public final IonWriter build(java.io.OutputStream out)
```
    Description copied from class: IonWriterBuilder
    
    Builds a new writer based on this builder's configuration properties.
    
    Specified by:
    
    build in class IonWriterBuilder
    
    Parameters:
    
    out - the stream that will receive Ion data. Must not be null.
    
    Returns:
    
    a new IonWriter instance; not null.
  - buildLegacy
```
@Deprecated
public final IonBinaryWriter buildLegacy()
```
    Deprecated.
  - mutationCheck
```
protected void mutationCheck()
```
    NOT FOR APPLICATION USE!
  - getCatalog
```
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
```
public final SymbolTable[] getImports()
```
    Gets the imports that will be used to construct the initial local symbol table.
    
    Returns:
    
    may be null or empty.
    
    See Also:
    
    setImports(SymbolTable...), withImports(SymbolTable...)

Class _Private_IonBinaryWriterBuilder

Nested Class Summary

Nested classes/interfaces inherited from class com.amazon.ion.system.IonWriterBuilder

Method Summary

Methods inherited from class com.amazon.ion.system.IonBinaryWriterBuilder

Methods inherited from class java.lang.Object

Method Detail

standard

copy

immutable

mutable

getSymtabValueFactory

setSymtabValueFactory

withSymtabValueFactory

getInitialSymbolTable

setInitialSymbolTable

withInitialSymbolTable

withAutoFlushEnabled

setAutoFlushEnabled

setLocalSymbolTableAppendEnabled

withLocalSymbolTableAppendEnabled

withLocalSymbolTableAppendDisabled

withBlockSize

setIsFloatBinary32Enabled

withFloatBinary32Enabled

withFloatBinary32Disabled

setImports

setCatalog

setStreamCopyOptimized

setBlockSize

build

buildLegacy

mutationCheck

getCatalog

getImports