com.amazon.ion.system

Enum IonWriterBuilder.IvmMinimizing

java.lang.Object

java.lang.Enum<IonWriterBuilder.IvmMinimizing>

com.amazon.ion.system.IonWriterBuilder.IvmMinimizing

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IonWriterBuilder.IvmMinimizing>

Enclosing class:

IonWriterBuilder

public static enum IonWriterBuilder.IvmMinimizing
extends java.lang.Enum<IonWriterBuilder.IvmMinimizing>

A strategy for minimizing the output of non-initial Ion version markers.

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

See Also:

IonTextWriterBuilder.setIvmMinimizing(IonWriterBuilder.IvmMinimizing)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADJACENT Replaces identical, adjacent IVMs with a single IVM.
DISTANT Discards IVMs that don't change the Ion version, even when there's other data between them.

Method Summary

Modifier and Type	Method and Description
static IonWriterBuilder.IvmMinimizing	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IonWriterBuilder.IvmMinimizing[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADJACENT

public static final IonWriterBuilder.IvmMinimizing ADJACENT

Replaces identical, adjacent IVMs with a single IVM.

DISTANT

public static final IonWriterBuilder.IvmMinimizing DISTANT

Discards IVMs that don't change the Ion version, even when there's other data between them. This includes adjacent IVMs.

Method Detail

values

public static IonWriterBuilder.IvmMinimizing[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IonWriterBuilder.IvmMinimizing c : IonWriterBuilder.IvmMinimizing.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IonWriterBuilder.IvmMinimizing valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null