com.luciad.format.aixm51.model.util

Aviation StandardsClass TLcdAIXM51Optional<T>

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.format.aixm51.model.util.TLcdAIXM51Optional<T>

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

public class TLcdAIXM51Optional<T>
extends TLcdDataObject

An optional is a ILcdDataObject with a value property and an optional nil reason property to explain why the value is not filled in.

This class is typically used as a UML association class. This means that it implements an association between two other classes. The value property (implemented by getValueObject() and setValueObject(Object)) is the role property of this association. In the large majority of cases, only the value of the role property is used by applications. In those cases, the association class can be considered to be a mere wrapper. Because of this, the API of the domain objects was made such that these association classes are not visible in the API. The getters and setters for properties of which the type is an association class directly expose the role property. Wrapping and unwrapping is done automatically by the implementation. Only when the application uses the generic ILcdDataObject API to access the domain objects, these association classes become visible.

Since:

10.0

See Also:

TLcdAssociationClassAnnotation

Constructor Summary

Constructors

Constructor and Description
TLcdAIXM51Optional(TLcdDataType aType) Creates a new optional for the given type.

Method Summary

Modifier and Type	Method and Description
TLcdGML32NilReasonEnumeration	getNilReason() Returns the nilReason attribute of this value.
T	getValueObject() Returns the value of the value property.
void	setNilReason(TLcdGML32NilReasonEnumeration aReason) Sets the nilReason attribute of the value.
void	setValueObject(T aValue) Sets the value of the value property to the given value
String	toString()

Methods inherited from class com.luciad.datamodel.TLcdDataObject

clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdAIXM51Optional

public TLcdAIXM51Optional(TLcdDataType aType)

Creates a new optional for the given type.

Parameters:

aType -

Method Detail

getNilReason

public TLcdGML32NilReasonEnumeration getNilReason()

Returns the nilReason attribute of this value. The nilReason should be set when the value is null.

Returns:

The nilReason, can be null.

setNilReason

public void setNilReason(TLcdGML32NilReasonEnumeration aReason)

Sets the nilReason attribute of the value. Set to null if the value is not null.

Parameters:

aReason - A nilReason or null.

getValueObject

public T getValueObject()

Returns the value of the value property. Note that this method is called getValueObject in order not to clash with existing getValue methods.

Returns:

the value of the value property

setValueObject

public void setValueObject(T aValue)

Sets the value of the value property to the given value

Parameters:

aValue - the value to set

toString

public String toString()

Overrides:

toString in class TLcdDataObject