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 java.lang.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 Summary

Constructors

Constructor and Description
DocCommentLine()

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(IAstVisitor visitor) This method welcomes a visitor that wants to visit this object.
DocCommentLine	copy() This method creates a shallow copy of this object.
static DocCommentLine	create(java.lang.String text, SourceLocation location) This method creates a new instance of this class.
SourceLocation	getLocation() Getter.
java.lang.String	getText() Getter.
DocCommentLine	setLocation(SourceLocation value) Setter.
DocCommentLine	setText(java.lang.String value) Setter.
java.util.Map<java.lang.String,java.lang.Object>	toMap() This method creates a map representation of this struct.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DocCommentLine

public DocCommentLine()

Method Detail

setText

public DocCommentLine setText(java.lang.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 java.lang.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(java.lang.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 java.util.Map<java.lang.String,java.lang.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object