agi.foundation.cesium

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

Class CzmlDocumentPacketizer

java.lang.Object

agi.foundation.cesium.CzmlDocumentPacketizer

All Implemented Interfaces:

ICzmlDocumentPacketizer

public class CzmlDocumentPacketizer
extends Object
implements ICzmlDocumentPacketizer

Generates a CZML document one packet at a time to allow for incremental processing by client applications.

Method Summary

Modifier and Type	Method and Description
CesiumGenerationStatus	generateNextPacket() Writes a single CZML packet to the writer that was provided to this packetizer when it was created.
CesiumGenerationStatus	generateNextPacket(Writer writer) Writes a single CZML packet to the provided writer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

generateNextPacket

@Nonnull
public final CesiumGenerationStatus generateNextPacket()

Writes a single CZML packet to the writer that was provided to this packetizer when it was created.

Specified by:

generateNextPacket in interface ICzmlDocumentPacketizer

Returns:

CesiumGenerationStatus.DONE if all packets have been generated; otherwise CesiumGenerationStatus.MORE_TO_GENERATE.

Throws:

IllegalStateException - Thrown when this object was not created with a writer.

DataUnavailableException - Thrown when all CZML has been generated.

generateNextPacket

@Nonnull
public final CesiumGenerationStatus generateNextPacket(Writer writer)

Writes a single CZML packet to the provided writer.

Specified by:

generateNextPacket in interface ICzmlDocumentPacketizer

Parameters:

writer - The writer to write to.

Returns:

CesiumGenerationStatus.DONE if all packets have been generated; otherwise CesiumGenerationStatus.MORE_TO_GENERATE.

Throws:

ArgumentNullException - Thrown when writer is null.

DataUnavailableException - Thrown when all CZML has been generated.