Package tools.refinery.store.representation

Record Class Symbol<T>

java.lang.Object
java.lang.Record
tools.refinery.store.representation.Symbol<T>
All Implemented Interfaces:
AnySymbol
public record Symbol<T>(String name, int arity, Class<T> valueType, T defaultValue) extends Record implements AnySymbol

  • Constructor Summary

    Constructors
    Constructor
    Description
    Symbol(String name, int arity, Class<T> valueType, T defaultValue)
    Creates an instance of a Symbol record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    arity()
    Returns the value of the arity record component.
    T
    defaultValue()
    Returns the value of the defaultValue record component.
    boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    hashCode()
    Returns a hash code value for this object.
    String
    name()
    Returns the value of the name record component.
    static Symbol<Boolean>
    of(String name, int arity)
     
    static <T> Symbol<T>
    of(String name, int arity, Class<T> valueType)
     
    static <T> Symbol<T>
    of(String name, int arity, Class<T> valueType, T defaultValue)
     
    @NotNull String
    toString()
    Returns a string representation of this record class.
    Class<T>
    valueType()
    Returns the value of the valueType record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Symbol

      public Symbol(String name, int arity, Class<T> valueType, T defaultValue)
      Creates an instance of a Symbol record class.
      Parameters:
      name - the value for the name record component
      arity - the value for the arity record component
      valueType - the value for the valueType record component
      defaultValue - the value for the defaultValue record component

  • Method Details

    • equals

      public 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • hashCode

      public 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

    • toString

      @NotNull public @NotNull 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

    • of

      public static Symbol<Boolean> of(String name, int arity)

    • of

      public static <T> Symbol<T> of(String name, int arity, Class<T> valueType)

    • of

      public static <T> Symbol<T> of(String name, int arity, Class<T> valueType, T defaultValue)

    • name

      public String name()
      Returns the value of the name record component.
      Specified by:
      name in interface AnySymbol
      Returns:
      the value of the name record component

    • arity

      public int arity()
      Returns the value of the arity record component.
      Specified by:
      arity in interface AnySymbol
      Returns:
      the value of the arity record component

    • valueType

      public Class<T> valueType()
      Returns the value of the valueType record component.
      Specified by:
      valueType in interface AnySymbol
      Returns:
      the value of the valueType record component

    • defaultValue

      public T defaultValue()
      Returns the value of the defaultValue record component.
      Returns:
      the value of the defaultValue record component