zserio.ast

Class DocLineElement

java.lang.Object

zserio.ast.AstNodeBase

zserio.ast.DocLineElement

All Implemented Interfaces:

AstNode

public final class DocLineElement
extends AstNodeBase

Documentation node which wraps documentation line element which can be either DocText or DocTagSee.

Constructor Summary

Constructors

Constructor and Description
DocLineElement(AstLocation location, DocTagSee seeTag) Constructor from see tag.
DocLineElement(AstLocation location, DocText docText) Constructor from text element.

Method Summary

Modifier and Type	Method and Description
void	accept(ZserioAstVisitor visitor) Accept zserio visitor.
DocText	getDocText() Gets text element if available.
DocTagSee	getSeeTag() Gets see tag if available.
void	visitChildren(ZserioAstVisitor visitor) Visit children of the current AST node using given visitor.

Methods inherited from class zserio.ast.AstNodeBase

getLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

DocLineElement

public DocLineElement(AstLocation location,
                      DocText docText)

Constructor from text element.

Parameters:

location - Location of this AST node.

docText - Documentation text.

DocLineElement

public DocLineElement(AstLocation location,
                      DocTagSee seeTag)

Constructor from see tag.

Parameters:

location - AST node location.

seeTag - See tag.

Method Detail

accept

public void accept(ZserioAstVisitor visitor)

Description copied from interface: AstNode

Accept zserio visitor.

Parameters:

visitor - Visitor to accept.

visitChildren

public void visitChildren(ZserioAstVisitor visitor)

Description copied from interface: AstNode

Visit children of the current AST node using given visitor.

Specified by:

visitChildren in interface AstNode

Overrides:

visitChildren in class AstNodeBase

Parameters:

visitor - Visitor to use.

getDocText

public DocText getDocText()

Gets text element if available.

Returns:

Text element or null.

getSeeTag

public DocTagSee getSeeTag()

Gets see tag if available.

Returns:

See tag or null.