Record Class ProgramCodeSites.Site

java.lang.Object
java.lang.Record
org.ek9lang.compiler.phase5.ProgramCodeSites.Site
Enclosing class:
ProgramCodeSites
static record ProgramCodeSites.Site(Reach reach, boolean changesNamedInPlace) extends Record
One place where code of the program's own may run: what it reaches, and whether it changes the names it is given in place (an in-place write, an iteration) rather than handing them to a call.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Site(Reach reach, boolean changesNamedInPlace)
    Creates an instance of a Site record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    changesNamedInPlace()
    Returns the value of the changesNamedInPlace record component.
    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.
    Reach
    reach()
    Returns the value of the reach 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

    • Site

      Site(Reach reach, boolean changesNamedInPlace)
      Creates an instance of a Site record class.
      Parameters:
      reach - the value for the reach record component
      changesNamedInPlace - the value for the changesNamedInPlace 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.

    • reach

      public Reach reach()
      Returns the value of the reach record component.
      Returns:
      the value of the reach record component

    • changesNamedInPlace

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