agi.foundation.cesium

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

Class CesiumCustomProperties

java.lang.Object

agi.foundation.cesium.CesiumCustomProperties

public class CesiumCustomProperties
extends Object

A set of custom CZML properties to be written for a particular object.

Constructor Summary

Constructors

Constructor and Description
CesiumCustomProperties() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
<T> void	addCustomProperty(TypeLiteral<T> typeLiteralT, String propertyName, CesiumProperty<T> property) Add a custom property.
<T> CesiumProperty<T>	getCustomProperty(String propertyName) Get a previously added custom property.
void	removeCustomProperty(String propertyName) Removes a custom property.

Methods inherited from class java.lang.Object

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

Constructor Detail

CesiumCustomProperties

public CesiumCustomProperties()

Initializes a new instance.

Method Detail

addCustomProperty

public final <T> void addCustomProperty(TypeLiteral<T> typeLiteralT,
                                        @Nonnull
                                        String propertyName,
                                        @Nonnull
                                        CesiumProperty<T> property)

Add a custom property.

Type Parameters:

T - The type of the data.

Parameters:

typeLiteralT - A TypeLiteral object representing the generic type T.

propertyName - The name of the custom property. This must be unique.

property - The custom property.

Throws:

ArgumentNullException - Thrown when property is null.

ArgumentException - Thrown when T is not a supported type of custom CZML property.

removeCustomProperty

public final void removeCustomProperty(@Nonnull
                                       String propertyName)

Removes a custom property.

Parameters:

propertyName - The name of the custom property.

getCustomProperty

public final <T> CesiumProperty<T> getCustomProperty(@Nonnull
                                                     String propertyName)

Get a previously added custom property.

Type Parameters:

T - The type of the data.

Parameters:

propertyName - The name of the custom property.

Returns:

The previously added custom property, or null if there is no property with the given name.