agi.foundation.cesium

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

Class CesiumOutputStream

java.lang.Object

agi.foundation.cesium.CesiumOutputStream

public class CesiumOutputStream
extends Object

A stream to which raw CZML data can be written. This is a low-level class that does not extensively validate that methods are called in a valid order, so it can be used to generate invalid JSON.

Constructor Summary

Constructors

Constructor and Description
CesiumOutputStream(Writer writer) Initializes a new instance.
CesiumOutputStream(Writer writer, boolean prettyFormatting) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	getPrettyFormatting() Gets a value indicating whether or not the written data should be formatted for easy human readability.
void	setPrettyFormatting(boolean value) Sets a value indicating whether or not the written data should be formatted for easy human readability.
void	writeEndObject() Writes the end of an object.
void	writeEndSequence() Writes the end of a sequence.
void	writeLineBreak() When PrettyFormatting (get / set) is true, adds a line break in a sequence of simple values.
void	writePropertyName(String propertyName) Writes the name of a property.
void	writeStartObject() Writes the start of an object.
void	writeStartSequence() Writes the start of a sequence.
void	writeValue(boolean value) Writes the value of a property or element in a sequence.
void	writeValue(double value) Writes the value of a property or element in a sequence.
void	writeValue(int value) Writes the value of a property or element in a sequence.
void	writeValue(long value) Writes the value of a property or element in a sequence.
void	writeValue(String value) Writes the value of a property or element in a sequence.
void	writeValue(URI value) Writes the value of a property or element in a sequence.

Methods inherited from class java.lang.Object

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

Constructor Detail

CesiumOutputStream

public CesiumOutputStream(@Nonnull
                          Writer writer)

Initializes a new instance.

Parameters:

writer - The writer to which data will be written.

CesiumOutputStream

public CesiumOutputStream(@Nonnull
                          Writer writer,
                          boolean prettyFormatting)

Initializes a new instance.

Parameters:

writer - The writer to which data will be written.

prettyFormatting - Whether or not the written data should be formatted for easy human readability.

Method Detail

getPrettyFormatting

public final boolean getPrettyFormatting()

Gets a value indicating whether or not the written data should be formatted for easy human readability. When this property is false (the default), more compact CZML is generated.

setPrettyFormatting

public final void setPrettyFormatting(boolean value)

Sets a value indicating whether or not the written data should be formatted for easy human readability. When this property is false (the default), more compact CZML is generated.

writeStartObject

public void writeStartObject()

Writes the start of an object.

writeEndObject

public void writeEndObject()

Writes the end of an object.

writeStartSequence

public void writeStartSequence()

Writes the start of a sequence.

writeEndSequence

public void writeEndSequence()

Writes the end of a sequence.

writePropertyName

public void writePropertyName(@Nonnull
                              String propertyName)

Writes the name of a property.

Parameters:

propertyName - The name of the property.

writeValue

public void writeValue(@Nullable
                       String value)

Writes the value of a property or element in a sequence.

Parameters:

value - The value to write.

writeValue

public void writeValue(double value)

Writes the value of a property or element in a sequence.

Parameters:

value - The value to write.

writeValue

public void writeValue(int value)

Writes the value of a property or element in a sequence.

Parameters:

value - The value to write.

writeValue

public void writeValue(long value)

Writes the value of a property or element in a sequence.

Parameters:

value - The value to write.

writeValue

public void writeValue(boolean value)

Writes the value of a property or element in a sequence.

Parameters:

value - The value to write.

writeValue

public void writeValue(@Nonnull
                       URI value)

Writes the value of a property or element in a sequence.

Parameters:

value - The value to write.

writeLineBreak

public void writeLineBreak()

When PrettyFormatting (get / set) is true, adds a line break in a sequence of simple values. When PrettyFormatting (get / set) is false, this method does nothing.