Module com.darkcollective.relix.ast
Package com.darkcollective.relix.ast

Record Class Comment

java.lang.Object
java.lang.Record
com.darkcollective.relix.ast.Comment
Record Components:
text - the comment, from its opening marker to the end of the line for -- (the newline excluded) or to its closing marker for /* … */; never null
location - where its opening marker is; never null
public record Comment(String text, SourceLocation location) extends Record
A comment as it was written in a script, and where.

The lexers skip comments, so nothing above them reads one; a parser keeps them only so that a printer can put them back. The text is the comment exactly as written, markers included: -- keep the large orders, or /* … */ with every line it spans.

Since:
1.0

  • Constructor Details

    • Comment

      public Comment(String text, SourceLocation location)
      Checks both components.
      Since:
      1.0

  • Method Details

    • isLineComment

      public boolean isLineComment()
      Returns whether this runs to the end of its line, so code cannot follow it there.
      Returns:
      whether this runs to the end of its line, so code cannot follow it there

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • text

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

    • location

      public SourceLocation location()
      Returns the value of the location record component.
      Returns:
      the value of the location record component