com.amazon.ion

Enum IonCursor.Event

java.lang.Object

java.lang.Enum<IonCursor.Event>

com.amazon.ion.IonCursor.Event

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IonCursor.Event>

Enclosing interface:

IonCursor

public static enum IonCursor.Event
extends java.lang.Enum<IonCursor.Event>

Conveys the type of event that occurred as a result of operating on the cursor.

Enum Constant Summary

Enum Constants

Enum Constant and Description
END_CONTAINER The cursor has reached the end of the current container, and requires an instruction to proceed.
NEEDS_DATA There is not enough data in the stream to complete the requested operation.
NEEDS_INSTRUCTION The cursor has completed an operation (e.g.
START_CONTAINER The cursor is positioned on a container value.
START_SCALAR The cursor is positioned on a scalar value.
VALUE_READY The cursor has successfully buffered the entirety of the value on which it is currently positioned, as requested by an invocation of `fillValue()`.

Method Summary

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

NEEDS_DATA

public static final IonCursor.Event NEEDS_DATA

There is not enough data in the stream to complete the requested operation. The operation should be retried when more data is available. Note that there is no way to "cancel" a previously requested operation; requesting a different operation after a `NEEDS_DATA` event has undefined behavior.

NEEDS_INSTRUCTION

public static final IonCursor.Event NEEDS_INSTRUCTION

The cursor has completed an operation (e.g. `stepIntoContainer()`) and requires another instruction in order to position itself on the next value.

START_SCALAR

public static final IonCursor.Event START_SCALAR

The cursor is positioned on a scalar value.

VALUE_READY

public static final IonCursor.Event VALUE_READY

The cursor has successfully buffered the entirety of the value on which it is currently positioned, as requested by an invocation of `fillValue()`.

START_CONTAINER

public static final IonCursor.Event START_CONTAINER

The cursor is positioned on a container value.

END_CONTAINER

public static final IonCursor.Event END_CONTAINER

The cursor has reached the end of the current container, and requires an instruction to proceed.

Method Detail

values

public static IonCursor.Event[] 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 (IonCursor.Event c : IonCursor.Event.values())
    System.out.println(c);

Returns:

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

valueOf

public static IonCursor.Event 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