Package autumn.lang.compiler.ast.nodes

Class DocCommentLine

java.lang.Object
autumn.lang.compiler.ast.nodes.DocCommentLine
All Implemented Interfaces:
IConstruct
public final class DocCommentLine extends Object implements IConstruct
An instance of this class is an AST node that represents a single line within a doc-comment.

Property Name Property Description
text This si the actual text of the comment line.
location This is the source-location information regarding this construct.

This file was auto-generated on (Sun May 31 11:54:12 EDT 2015).

  • Constructor Details

    • DocCommentLine

      public DocCommentLine()

  • Method Details

    • setText

      public DocCommentLine setText(String value)
      Setter.
      Parameters:
      value - is the new value of property text.
      Returns:
      a copy of this object with property text set to value.

    • getText

      public String getText()
      Getter.
      Returns:
      the value of property text.

    • setLocation

      public DocCommentLine setLocation(SourceLocation value)
      Setter.
      Specified by:
      setLocation in interface IConstruct
      Parameters:
      value - is the new value of property location.
      Returns:
      a copy of this object with property location set to value.

    • getLocation

      public SourceLocation getLocation()
      Getter.
      Specified by:
      getLocation in interface IConstruct
      Returns:
      the value of property location.

    • create

      public static DocCommentLine create(String text, SourceLocation location)
      This method creates a new instance of this class.
      Parameters:
      text - is the value for property text.
      location - is the value for property location.
      Returns:
      a new instance of this class.

    • accept

      public void accept(IAstVisitor visitor)
      This method welcomes a visitor that wants to visit this object.
      Specified by:
      accept in interface IConstruct
      Parameters:
      visitor - is the visitor that is visiting this object.

    • copy

      public DocCommentLine copy()
      This method creates a shallow copy of this object.
      Specified by:
      copy in interface IConstruct
      Returns:
      a shallow copy of this object.

    • toMap

      public Map<String,Object> toMap()
      This method creates a map representation of this struct.

      Each key is the name of a field. Each value is the result of calling the key field's getter.

      Returns:
      a map containing the entries in this struct.

    • toString

      public String toString()
      Overrides:
      toString in class Object