com.amazon.ion.system

Enum IonWriterBuilder.InitialIvmHandling

java.lang.Object

java.lang.Enum<IonWriterBuilder.InitialIvmHandling>

com.amazon.ion.system.IonWriterBuilder.InitialIvmHandling

All Implemented Interfaces:

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

Enclosing class:

IonWriterBuilder

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

A strategy for altering emission of Ion version markers at the start of an Ion stream.

See Also:

IonTextWriterBuilder.setInitialIvmHandling(IonWriterBuilder.InitialIvmHandling)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENSURE Always emits an initial IVM, even when the user hasn't explicitly written one.
SUPPRESS Indicates that initial IVMs should be suppressed from the output stream whenever possible, even when they are explicitly written.

Method Summary

Modifier and Type	Method and Description
static IonWriterBuilder.InitialIvmHandling	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IonWriterBuilder.InitialIvmHandling[]	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

ENSURE

public static final IonWriterBuilder.InitialIvmHandling ENSURE

Always emits an initial IVM, even when the user hasn't explicitly written one. If the user does write one, this won't cause an extra to be emitted.

SUPPRESS

public static final IonWriterBuilder.InitialIvmHandling SUPPRESS

Indicates that initial IVMs should be suppressed from the output stream whenever possible, even when they are explicitly written.

Method Detail

values

public static IonWriterBuilder.InitialIvmHandling[] 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.InitialIvmHandling c : IonWriterBuilder.InitialIvmHandling.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.InitialIvmHandling 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