Detailed Description
This interface can be used where engines have a property that may be populated and may not.
- See also
- Specification
- Parameters
-
<T> the type of data stored within the instance
Inheritance diagram for fiftyone.pipeline.engines.data.AspectPropertyValue< T >:
Public Member Functions | |
| boolean | hasValue () |
| Indicates whether or not the instance contains a value for the property. | |
| T | getValue () throws NoValueException |
| Get the underlying value. | |
| void | setValue (T value) |
| Set the underlying value. | |
| String | getNoValueMessage () |
| Get the message that will appear in the exception thrown if this instance has no value. | |
| void | setNoValueMessage (String message) |
| Set the message that will appear in the exception thrown if this instance has no value. | |
Member Function Documentation
◆ getNoValueMessage()
| String fiftyone.pipeline.engines.data.AspectPropertyValue< T >.getNoValueMessage | ( | ) |
Get the message that will appear in the exception thrown if this instance has no value.
- Returns
- message associated with the NoValueException
Implemented in fiftyone.pipeline.engines.data.AspectPropertyValueDefault< T >.
◆ getValue()
| T fiftyone.pipeline.engines.data.AspectPropertyValue< 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
Implemented in fiftyone.pipeline.engines.data.AspectPropertyValueDefault< T >.
◆ hasValue()
| boolean fiftyone.pipeline.engines.data.AspectPropertyValue< T >.hasValue | ( | ) |
Indicates whether or not the instance contains a value for the property.
- Returns
- true if this instance contains a value, false otherwise
Implemented in fiftyone.pipeline.engines.data.AspectPropertyValueDefault< T >.
◆ setNoValueMessage()
| void fiftyone.pipeline.engines.data.AspectPropertyValue< 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
Implemented in fiftyone.pipeline.engines.data.AspectPropertyValueDefault< T >.
◆ setValue()
| void fiftyone.pipeline.engines.data.AspectPropertyValue< T >.setValue | ( | T | value | ) |
Set the underlying value.
- Parameters
-
value the value to set
Implemented in fiftyone.pipeline.engines.data.AspectPropertyValueDefault< T >.