Package com.aquima.interactions.foundation.types

Class InfiniteValue

java.lang.Object
com.aquima.interactions.foundation.convert.Convertable
com.aquima.interactions.foundation.types.InfiniteValue
All Implemented Interfaces:
IConvertable, IPrimitiveValue, ISingleValue, IValue, Serializable, Comparable<Object>
Direct Known Subclasses:
AttributeInfiniteValue
public class InfiniteValue extends Convertable implements ISingleValue
This class represents an infinite value, which is usually only used when working with ranges.
Since:
5.0
Author:
O. Kerpershoek
See Also:

  • Constructor Details

    • InfiniteValue

      public InfiniteValue(InfiniteValue other)
      Copy constructor.
      Parameters:
      other - value to copy.

  • Method Details

    • negative

      public static InfiniteValue negative(DataType type)
      Constructs the negative infinity for the specified data type.
      Parameters:
      type - The data type the negative infinity is requested for.
      Returns:
      The negative infinity for the specified data type.

    • positive

      public static InfiniteValue positive(DataType type)
      Constructs the positive infinity for the specified data type.
      Parameters:
      type - The data type the positive infinity is requested for.
      Returns:
      The positive infinity for the specified data type.

    • getTypeName

      public String 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 interface IPrimitiveValue
      Returns:
      The type of the value.

    • getDisplayValue

      public String getDisplayValue(String languageCode, IValueFormatter formatter)
      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 interface IPrimitiveValue
      Parameters:
      languageCode - the code of the language
      formatter - optional formatter
      Returns:
      A string containing the display value for the specified language.

    • getDataType

      public DataType getDataType()
      Description copied from interface: IValue
      This method returns the data type of the value.
      Specified by:
      getDataType in interface IValue
      Returns:
      The data type of the value.

    • forType

      public IPrimitiveValue forType(String typeName, IMultilingualText displayValue)
      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 interface IPrimitiveValue
      Parameters:
      typeName - The type of the value.
      displayValue - Multilingual text containing display values.
      Returns:
      The value with the added information.

    • isNegative

      public boolean isNegative()
      This method returns a boolean indicating if this class represents a negative infinity value.
      Returns:
      a boolean indicating if this class represents a negative infinity value.

    • isPositive

      public boolean isPositive()
      This method returns a boolean indicating if this class represents a positive infinity value.
      Returns:
      a boolean indicating if this class represents a positive infinity value.

    • contains

      public boolean contains(Object objValue)
      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.
      Specified by:
      contains in interface IValue
      Parameters:
      objValue - Object for which should be checked if it is entirely part of this value.
      Returns:
      boolean indicating if the object passed is entirely part of this value.

    • isUnknown

      public boolean isUnknown()
      Description copied from interface: IValue
      This method returns a boolean indicating if the value is unknown.
      Specified by:
      isUnknown in interface IValue
      Returns:
      boolean indicating if the value is unknown.

    • 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 interface IValue
      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 interface IValue
      Returns:
      boolean indicating if the value represent a range value.

    • toSingleValue

      public ISingleValue 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 interface IValue
      Returns:
      The same value as single value.

    • toRangeValue

      public IRangeValue 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 interface IValue
      Returns:
      The same value as a range value.

    • toListValue

      public IListValue 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 interface IValue
      Returns:
      The same value as list.

    • getValue

      public Object getValue()
      Description copied from interface: IConvertable
      This method returns the internal object of this instance without any conversion.
      Specified by:
      getValue in interface IConvertable
      Specified by:
      getValue in class Convertable
      Returns:
      The internal Object of this attribute value.

    • compareTo

      public int compareTo(Object other)
      Specified by:
      compareTo in interface Comparable<Object>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • duplicate

      public IValue duplicate()
      Description copied from interface: IValue
      This method returns a deep copy of the value.
      Specified by:
      duplicate in interface IValue
      Returns:
      A deep clone.