Module aya.base
Package org.aya.concrete.stmt

Record Class Command.Open

java.lang.Object
java.lang.Record
org.aya.concrete.stmt.Command.Open
All Implemented Interfaces:
Command, Stmt, AyaDocile, TyckUnit, org.aya.util.error.SourceNode
Enclosing interface:
Command
public static record Command.Open(@NotNull org.aya.util.error.SourcePos sourcePos, @NotNull Stmt.Accessibility accessibility, @NotNull QualifiedID path, @NotNull UseHide useHide, boolean openExample, boolean fromSugar) extends Record implements Command

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.aya.concrete.stmt.Command

    Command.Import, Command.Module, Command.Open

    Nested classes/interfaces inherited from interface org.aya.concrete.stmt.Stmt

    Stmt.Accessibility

  • Constructor Summary

    Constructors
    Constructor
    Description
    Open(@NotNull org.aya.util.error.SourcePos sourcePos, @NotNull Stmt.Accessibility accessibility, @NotNull QualifiedID path, @NotNull UseHide useHide, boolean openExample, boolean fromSugar)
    Creates an instance of a Open record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull Stmt.Accessibility
    accessibility()
    Returns the value of the accessibility record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    fromSugar()
    Returns the value of the fromSugar record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    openExample()
    Returns the value of the openExample record component.
    @NotNull QualifiedID
    path()
    Returns the value of the path record component.
    @NotNull org.aya.util.error.SourcePos
    sourcePos()
    Returns the value of the sourcePos record component.
    final String
    toString()
    Returns a string representation of this record class.
    @NotNull UseHide
    useHide()
    Returns the value of the useHide record component.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.aya.generic.AyaDocile

    debuggerOnlyToDoc

    Methods inherited from interface org.aya.concrete.stmt.Command

    needTyck

    Methods inherited from interface org.aya.concrete.stmt.Stmt

    desugar, toDoc

  • Constructor Details

    • Open

      public Open(@NotNull @NotNull org.aya.util.error.SourcePos sourcePos, @NotNull @NotNull Stmt.Accessibility accessibility, @NotNull @NotNull QualifiedID path, @NotNull @NotNull UseHide useHide, boolean openExample, boolean fromSugar)
      Creates an instance of a Open record class.
      Parameters:
      sourcePos - the value for the sourcePos record component
      accessibility - the value for the accessibility record component
      path - the value for the path record component
      useHide - the value for the useHide record component
      openExample - the value for the openExample record component
      fromSugar - the value for the fromSugar 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 '=='.
      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.

    • sourcePos

      @NotNull public @NotNull org.aya.util.error.SourcePos sourcePos()
      Returns the value of the sourcePos record component.
      Specified by:
      sourcePos in interface org.aya.util.error.SourceNode
      Returns:
      the value of the sourcePos record component

    • accessibility

      @NotNull public @NotNull Stmt.Accessibility accessibility()
      Returns the value of the accessibility record component.
      Specified by:
      accessibility in interface Stmt
      Returns:
      the value of the accessibility record component

    • path

      @NotNull public @NotNull QualifiedID path()
      Returns the value of the path record component.
      Returns:
      the value of the path record component

    • useHide

      @NotNull public @NotNull UseHide useHide()
      Returns the value of the useHide record component.
      Returns:
      the value of the useHide record component

    • openExample

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

    • fromSugar

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