Record Class CompilationPhaseResult

java.lang.Object
java.lang.Record
org.ek9lang.compiler.CompilationPhaseResult
public record CompilationPhaseResult(CompilationPhase phase, boolean phaseSuccess, boolean phaseMatch) extends Record
Effectively a tuple for returning if the phase was a match for the required compilation phase to be run to and if this phase ran ok.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CompilationPhaseResult(CompilationPhase phase, boolean phaseSuccess, boolean phaseMatch)
    Creates an instance of a CompilationPhaseResult 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.
    CompilationPhase
    phase()
    Returns the value of the phase record component.
    boolean
    phaseMatch()
    Returns the value of the phaseMatch record component.
    boolean
    phaseSuccess()
    Returns the value of the phaseSuccess 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

    • CompilationPhaseResult

      public CompilationPhaseResult(CompilationPhase phase, boolean phaseSuccess, boolean phaseMatch)
      Creates an instance of a CompilationPhaseResult record class.
      Parameters:
      phase - the value for the phase record component
      phaseSuccess - the value for the phaseSuccess record component
      phaseMatch - the value for the phaseMatch 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.

    • phase

      public CompilationPhase phase()
      Returns the value of the phase record component.
      Returns:
      the value of the phase record component

    • phaseSuccess

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

    • phaseMatch

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