Module org.praxislive.core
Package org.praxislive.core.services

Record Class ComponentFactory.Deprecated

java.lang.Object
java.lang.Record
org.praxislive.core.services.ComponentFactory.Deprecated
Enclosing interface:
ComponentFactory
public static record ComponentFactory.Deprecated(Optional<ComponentType> replacement) extends Record
Mark a component deprecated (with optional replacement type). An instance should be added to the metadata lookup associated with the component type.

  • Constructor Details

    • Deprecated

      public Deprecated()
      Deprecated without replacement.

    • Deprecated

      public Deprecated(ComponentType replacement)
      Deprecated with replacement type.
      Parameters:
      replacement - replacement type

    • Deprecated

      public Deprecated(Optional<ComponentType> replacement)
      Creates an instance of a Deprecated record class.
      Parameters:
      replacement - the value for the replacement record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • replacement

      public Optional<ComponentType> replacement()
      Returns the value of the replacement record component.
      Returns:
      the value of the replacement record component