agi.foundation.cesium

(agi.foundation.cesium-2024r2.jar)

Enum CesiumGenerationStatus

java.lang.Object

java.lang.Enum<CesiumGenerationStatus>

agi.foundation.cesium.CesiumGenerationStatus

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CesiumGenerationStatus>

public enum CesiumGenerationStatus
extends Enum<CesiumGenerationStatus>
implements Enumeration

The return value of a call to ICzmlDocumentPacketizer.generateNextPacket().

Enum Constant Summary

Enum Constants

Enum Constant and Description
DONE All data has been written.
MORE_TO_GENERATE There is more data to write.

Method Summary

Modifier and Type	Method and Description
static CesiumGenerationStatus	getDefault() Get the enum constant that is considered to be the default.
static CesiumGenerationStatus	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static CesiumGenerationStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static CesiumGenerationStatus[]	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

DONE

public static final CesiumGenerationStatus DONE

All data has been written. No further calls to ICzmlDocumentPacketizer.generateNextPacket() are needed.

MORE_TO_GENERATE

public static final CesiumGenerationStatus MORE_TO_GENERATE

There is more data to write. ICzmlDocumentPacketizer.generateNextPacket() should be called again to write the next packet.

Method Detail

values

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

Returns:

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

valueOf

public static CesiumGenerationStatus valueOf(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:

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

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static CesiumGenerationStatus getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static CesiumGenerationStatus getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.