Record Class IGParameter<K,V>

java.lang.Object
java.lang.Record
fr.inria.rules.integraal.configuration.parameters.IGParameter<K,V>
Type Parameters:
K - a generic type for the name
V - a generic type for the value
Record Components:
name - identifies a service parameter
value - provides a value for this parameter if required
public record IGParameter<K,V>(K name, V value) extends Record
Structure used to describe an InteGraal API service parameter When used with InteGraalKeywords it runs a sanity check on the parameter value.

  • Constructor Summary

    Constructors
    Constructor
    Description
    IGParameter(K name, V value)
    Creates a parameter and validates it when backed by InteGraalKeywords.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    K
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.
    V
    value()
    Returns the value of the value record component.

    Methods inherited from class Object

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

  • Constructor Details

    • IGParameter

      public IGParameter(K name, V value)
      Creates a parameter and validates it when backed by InteGraalKeywords.
      Parameters:
      name - the parameter name
      value - the parameter value

  • 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.

    • name

      public K name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • value

      public V value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component