Module org.praxislive.core
Package org.praxislive.core.types

Class PMap.MapBasedValue

java.lang.Object
org.praxislive.core.Value
org.praxislive.core.types.PMap.MapBasedValue
Direct Known Subclasses:
ArgumentInfo, ComponentInfo, ControlInfo, PortInfo
Enclosing class:
PMap
public abstract static class PMap.MapBasedValue extends Value
An abstract superclass for values that are backed solely by a PMap. Subclassing this type can help with efficient serialization of the underlying representation. The concrete value type must be able to construct an equivalent value entirely from the PMap returned from dataMap().

The toString, equals, equivalent and hashCode methods are all implemented based solely on the map data.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.praxislive.core.Value

    Value.Type<T extends Value>

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    MapBasedValue(PMap data)
    Construct a MapBasedValue using the provided data map.

  • Method Summary

    Modifier and Type
    Method
    Description
    final PMap
    dataMap()
    Access the backing PMap data.
    final boolean
    equals(Object obj)
    Values must override the default equals method.
    final boolean
    equivalent(Value value)
    Indicates whether some other Value is equivalent to this one.
    final int
    hashCode()
    Values must override the default hashcode method.
    final String
    toString()
    Values must override the default method to return a string representation that is immutable.

    Methods inherited from class org.praxislive.core.Value

    info, isEmpty, ofObject, type

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • MapBasedValue

      protected MapBasedValue(PMap data)
      Construct a MapBasedValue using the provided data map.
      Parameters:
      data - data map

  • Method Details

    • dataMap

      public final PMap dataMap()
      Access the backing PMap data.
      Returns:
      backing map

    • toString

      public final String toString()
      Description copied from class: Value
      Values must override the default method to return a string representation that is immutable.
      Specified by:
      toString in class Value
      Returns:
      String representation

    • hashCode

      public final int hashCode()
      Description copied from class: Value
      Values must override the default hashcode method.
      Specified by:
      hashCode in class Value
      Returns:
      int hashcode

    • equals

      public final boolean equals(Object obj)
      Description copied from class: Value
      Values must override the default equals method. This method should only return true if the supplied Object is of the same type as the implementing Value. Values of an unknown type should be coerced before calling this method. This method does not have to guarantee that this.equals(that) == this.toString().equals(that.toString())
      Specified by:
      equals in class Value
      Parameters:
      obj -
      Returns:
      boolean

    • equivalent

      public final boolean equivalent(Value value)
      Description copied from class: Value
      Indicates whether some other Value is equivalent to this one. Unlike Value.equals(java.lang.Object) this method is not symmetric - a value of a different type might be equivalent to this without the other type considering the reverse to be true.

      The default implementation uses identity or String equality.

      Overrides:
      equivalent in class Value
      Parameters:
      value - value to test for equivalence
      Returns:
      true if value is equivalent to this