Record Class CallMetaDataDetails

java.lang.Object
java.lang.Record
org.ek9lang.compiler.ir.data.CallMetaDataDetails
public record CallMetaDataDetails(boolean isPure, int complexityScore, Set<String> sideEffects) extends Record
Metadata about method/function/operator calls that can be used by backends for optimization. Includes purity information, complexity scoring, and side effect classification.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CallMetaDataDetails(boolean isPure, int complexityScore)
    Creates CallMetaDataDetails with no side effects.
    CallMetaDataDetails(boolean isPure, int complexityScore, Set<String> sideEffects)
    Creates an instance of a CallMetaDataDetails record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    complexityScore()
    Returns the value of the complexityScore record component.
    static CallMetaDataDetails
    defaultMetaData()
    Creates default CallMetaDataDetails for when no symbol information is available.
    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
    isPure()
    Returns the value of the isPure record component.
    Set<String>
    sideEffects()
    Returns the value of the sideEffects record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • CallMetaDataDetails

      public CallMetaDataDetails(boolean isPure, int complexityScore)
      Creates CallMetaDataDetails with no side effects.

    • CallMetaDataDetails

      public CallMetaDataDetails(boolean isPure, int complexityScore, Set<String> sideEffects)
      Creates an instance of a CallMetaDataDetails record class.
      Parameters:
      isPure - the value for the isPure record component
      complexityScore - the value for the complexityScore record component
      sideEffects - the value for the sideEffects record component

  • Method Details

    • defaultMetaData

      public static CallMetaDataDetails defaultMetaData()
      Creates default CallMetaDataDetails for when no symbol information is available. Assumes non-pure with zero complexity and no known side effects.

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

    • isPure

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

    • complexityScore

      public int complexityScore()
      Returns the value of the complexityScore record component.
      Returns:
      the value of the complexityScore record component

    • sideEffects

      public Set<String> sideEffects()
      Returns the value of the sideEffects record component.
      Returns:
      the value of the sideEffects record component