51Degrees Pipeline Java 4.2

51Degrees Pipeline for Java

Detailed Description

This class can be used where engines have a property that may be populated and may not.

It can be used to let the user know details of why a property value is not available. For example, if a property requires additional evidence from client side code before it can be populated.

Parameters: <T> - the type of data stored within the instance

Inheritance diagram for fiftyone.pipeline.engines.data.AspectPropertyValueDefault< T >:

Collaboration diagram for fiftyone.pipeline.engines.data.AspectPropertyValueDefault< T >:

Public Member Functions

	AspectPropertyValueDefault () Construct a new instance with no value set.
	AspectPropertyValueDefault (T value) Construct a new instance and set the value. More...
boolean	hasValue () Indicates whether or not the instance contains a value for the property. More...
T	getValue () throws NoValueException Get the underlying value. More...
void	setValue (T value) Set the underlying value. More...
String	getNoValueMessage () Get the message that will appear in the exception thrown if this instance has no value. More...
void	setNoValueMessage (String message) Set the message that will appear in the exception thrown if this instance has no value. More...
int	hashCode ()
boolean	equals (Object obj)
String	toString ()

Constructor & Destructor Documentation

◆ AspectPropertyValueDefault()

fiftyone.pipeline.engines.data.AspectPropertyValueDefault< T >.AspectPropertyValueDefault

(

T

value

)

Construct a new instance and set the value.

This also result in the 'hasValue' property being set to true.

Parameters: value - the value to set

Member Function Documentation

◆ getNoValueMessage()

String fiftyone.pipeline.engines.data.AspectPropertyValueDefault< T >.getNoValueMessage

(

)

Get the message that will appear in the exception thrown if this instance has no value.

Returns: message associated with the NoValueException

Implements fiftyone.pipeline.engines.data.AspectPropertyValue< T >.

◆ getValue()

T fiftyone.pipeline.engines.data.AspectPropertyValueDefault< T >.getValue

(

)

throws NoValueException

Get the underlying value.

Returns: the underlying value

Exceptions: NoValueException - this exception will be thrown if the instance does not contain a value

Implements fiftyone.pipeline.engines.data.AspectPropertyValue< T >.

◆ hasValue()

boolean fiftyone.pipeline.engines.data.AspectPropertyValueDefault< T >.hasValue

(

)

Indicates whether or not the instance contains a value for the property.

Returns: true if this instance contains a value, false otherwise

Implements fiftyone.pipeline.engines.data.AspectPropertyValue< T >.

◆ setNoValueMessage()

void fiftyone.pipeline.engines.data.AspectPropertyValueDefault< T >.setNoValueMessage

(

String

message

)

Set the message that will appear in the exception thrown if this instance has no value.

Parameters: message - associated with the NoValueException

Implements fiftyone.pipeline.engines.data.AspectPropertyValue< T >.

◆ setValue()

void fiftyone.pipeline.engines.data.AspectPropertyValueDefault< T >.setValue

(

T

value

)

Set the underlying value.

Parameters: value - the value to set

Implements fiftyone.pipeline.engines.data.AspectPropertyValue< T >.