Class AbstractValue
java.lang.Object
com.aquima.interactions.foundation.types.AbstractValue
- All Implemented Interfaces:
IConvertable
,IPrimitiveValue
,ISingleValue
,IValue
,Serializable
,Comparable<Object>
- Direct Known Subclasses:
AnyValue
,BinaryValue
,BooleanValue
,DateValue
,EntityValue
,IntegerValue
,NumberValue
,StringValue
Base class for primitive values.
- Since:
- 5.0
- Author:
- O. Kerpershoek
- See Also:
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AbstractValue
(AbstractValue other) protected
AbstractValue
(String typeName, IMultilingualText displayValue) -
Method Summary
Modifier and TypeMethodDescriptionabstract boolean
This method converts the internal value to a boolean primitive.protected abstract int
compareSimple
(Object obj) int
abstract boolean
This method returns a boolean indicating if the object passed to this method is entirely part of this value.abstract Date
This method converts the internal value to a date object.abstract double
This method converts the internal value to a double primitive.abstract IValue
This method returns a deep copy of the value.boolean
abstract IPrimitiveValue
forType
(String typeName, IMultilingualText displayValue) This method adds the type and display information to the value, and returns the value with this added information.abstract DataType
This method returns the data type of the value.getDisplayValue
(String languageCode, IValueFormatter formatter) This method returns a string that can be used as display value for the specified language.This method will return the (optional) type name of the value.abstract Object
getValue()
This method returns the internal object of this instance without any conversion.int
hashCode()
abstract int
This method converts the internal value to an integer primitive.boolean
This method returns a boolean indicating if this value may safely be converted to a range value by using the toRangeValue method.boolean
This method returns a boolean indicating if this value may safely be converted to a single value by using the toSingleValue method.abstract boolean
This method returns a boolean indicating if the value is unknown.abstract long
This method converts the internal value to a long primitive.abstract String
This method converts the internal value to a String object.This method will convert the current value to a list value.This method will attempt to convert the value to a range value.This method will attempt to convert the value to a single value.
-
Constructor Details
-
AbstractValue
-
AbstractValue
-
-
Method Details
-
compareSimple
-
doubleValue
public abstract double doubleValue()Description copied from interface:IConvertable
This method converts the internal value to a double primitive.- Specified by:
doubleValue
in interfaceIConvertable
- Returns:
- Double primitive of the internal value.
-
integerValue
public abstract int integerValue()Description copied from interface:IConvertable
This method converts the internal value to an integer primitive.- Specified by:
integerValue
in interfaceIConvertable
- Returns:
- Integer primitive of the internal value.
-
dateValue
Description copied from interface:IConvertable
This method converts the internal value to a date object.- Specified by:
dateValue
in interfaceIConvertable
- Returns:
- Date object of the internal value.
-
stringValue
Description copied from interface:IConvertable
This method converts the internal value to a String object.- Specified by:
stringValue
in interfaceIConvertable
- Returns:
- String object of the internal value.
-
longValue
public abstract long longValue()Description copied from interface:IConvertable
This method converts the internal value to a long primitive.- Specified by:
longValue
in interfaceIConvertable
- Returns:
- Long primitive of the internal value.
-
booleanValue
public abstract boolean booleanValue()Description copied from interface:IConvertable
This method converts the internal value to a boolean primitive.- Specified by:
booleanValue
in interfaceIConvertable
- Returns:
- Boolean primitive of the internal value.
-
duplicate
Description copied from interface:IValue
This method returns a deep copy of the value. -
isUnknown
public abstract boolean isUnknown()Description copied from interface:IValue
This method returns a boolean indicating if the value is unknown. -
contains
Description copied from interface:IValue
This method returns a boolean indicating if the object passed to this method is entirely part of this value. This method will thus also return true when the object passed is equal to this value, but the method will return false when only part (or none) of the object is represented by this value. Note that for value types that are singular in nature (for instance, implementations of ISingleValue) the operation of this method is limited to an equality check. -
getDataType
Description copied from interface:IValue
This method returns the data type of the value.- Specified by:
getDataType
in interfaceIValue
- Returns:
- The data type of the value.
-
getValue
Description copied from interface:IConvertable
This method returns the internal object of this instance without any conversion.- Specified by:
getValue
in interfaceIConvertable
- Returns:
- The internal Object of this attribute value.
-
forType
Description copied from interface:IPrimitiveValue
This method adds the type and display information to the value, and returns the value with this added information. The method will not change the state of the value the method is invoked on, but it will return a copy of the current value with the added information.- Specified by:
forType
in interfaceIPrimitiveValue
- Parameters:
typeName
- The type of the value.displayValue
- Multilingual text containing display values.- Returns:
- The value with the added information.
-
getDisplayValue
Description copied from interface:IPrimitiveValue
This method returns a string that can be used as display value for the specified language.- Specified by:
getDisplayValue
in interfaceIPrimitiveValue
- Parameters:
languageCode
- the code of the languageformatter
- optional formatter- Returns:
- A string containing the display value for the specified language.
-
getTypeName
Description copied from interface:IPrimitiveValue
This method will return the (optional) type name of the value. The type name is available when the value belongs to a typed set like a domain or entity. In case the value is part of a domain, the type name will contain the name of the domain the value belongs to.- Specified by:
getTypeName
in interfaceIPrimitiveValue
- Returns:
- The type of the value.
-
isSingleValue
public boolean isSingleValue()Description copied from interface:IValue
This method returns a boolean indicating if this value may safely be converted to a single value by using the toSingleValue method. Objects that are already a single value will always return true, but ranges and list values may return true when they only contain a single value.
Note: This method returns true when the value is convertible, it does not mean that the value can safely be casted to the ISingleValue interface.- Specified by:
isSingleValue
in interfaceIValue
- Returns:
- boolean indicating if the value represent a single value.
-
isRangeValue
public boolean isRangeValue()Description copied from interface:IValue
This method returns a boolean indicating if this value may safely be converted to a range value by using the toRangeValue method. Objects that are already a range or single value will always return true, but list values may return true when they only contain a single value.
Note: This method returns true when the value is convertable, it does not mean that the value can safely be casted to the IRangeValue interface.- Specified by:
isRangeValue
in interfaceIValue
- Returns:
- boolean indicating if the value represent a range value.
-
toSingleValue
Description copied from interface:IValue
This method will attempt to convert the value to a single value. The conversion might fail and raise an exception when the value this method is called on is either a range or a list value. The method isSingleValue can be used to determine if this value can safely be converted to a single value. When the value this method is called on already implements the ISingleValue interface, the implementation may return the same value.- Specified by:
toSingleValue
in interfaceIValue
- Returns:
- The same value as single value.
-
toRangeValue
Description copied from interface:IValue
This method will attempt to convert the value to a range value. The conversion might fail and raise an exception when the value this method is called on is either a list value. The method isRangeValue can be used to determine if this value can safely be converted to a range value. When the value this method is called on already implements the IRangeValue interface, the implementation may return the same value.- Specified by:
toRangeValue
in interfaceIValue
- Returns:
- The same value as a range value.
-
toListValue
Description copied from interface:IValue
This method will convert the current value to a list value. This type of conversion is always possible for all IValue implementations. Values of type ISingleValue or IRangeValue will result in a list value containing the primitive value (list of size 1). When the value this method is called on already implements the IListValue interface, the implementation may return the same value.- Specified by:
toListValue
in interfaceIValue
- Returns:
- The same value as list.
-
compareTo
- Specified by:
compareTo
in interfaceComparable<Object>
-
equals
-
hashCode
public int hashCode()
-