Record Class OperatorDetails

java.lang.Object
java.lang.Record
org.ek9lang.compiler.common.OperatorDetails
public record OperatorDetails(String operator, String mappedName, boolean markedPure, boolean requiresArgument, boolean hasReturn) extends Record
Holds some high level details about an operator. These by their very nature cannot be too detailed, because when used the actual types involved will vary. But we do need to try and gather together the nature of operators. See OperatorMap for use.

Also when generating the IR we need to know about purity and if a return is present. This aids in providing meta-data to the IR phase for optimisation and memory management.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OperatorDetails(String operator, String mappedName, boolean markedPure, boolean requiresArgument, boolean hasReturn)
    Creates an instance of a OperatorDetails record class.

  • 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.
    boolean
    hasReturn()
    Returns the value of the hasReturn record component.
    String
    mappedName()
    Returns the value of the mappedName record component.
    boolean
    markedPure()
    Returns the value of the markedPure record component.
    String
    operator()
    Returns the value of the operator record component.
    boolean
    requiresArgument()
    Returns the value of the requiresArgument record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OperatorDetails

      public OperatorDetails(String operator, String mappedName, boolean markedPure, boolean requiresArgument, boolean hasReturn)
      Creates an instance of a OperatorDetails record class.
      Parameters:
      operator - the value for the operator record component
      mappedName - the value for the mappedName record component
      markedPure - the value for the markedPure record component
      requiresArgument - the value for the requiresArgument record component
      hasReturn - the value for the hasReturn 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • operator

      public String operator()
      Returns the value of the operator record component.
      Returns:
      the value of the operator record component

    • mappedName

      public String mappedName()
      Returns the value of the mappedName record component.
      Returns:
      the value of the mappedName record component

    • markedPure

      public boolean markedPure()
      Returns the value of the markedPure record component.
      Returns:
      the value of the markedPure record component

    • requiresArgument

      public boolean requiresArgument()
      Returns the value of the requiresArgument record component.
      Returns:
      the value of the requiresArgument record component

    • hasReturn

      public boolean hasReturn()
      Returns the value of the hasReturn record component.
      Returns:
      the value of the hasReturn record component