org.openquark.cal.compiler
Class CALDocComment.ListItem

java.lang.Object
  org.openquark.cal.compiler.CALDocComment.ListItem

Enclosing class:

CALDocComment

public static final class CALDocComment.ListItem
extends Object

Represents a list item within a CALDoc comment, either in a ordered list or an unordered list.

Author:

Joseph Wong

Method Summary

<T,R> R	accept(CALDocCommentTextBlockVisitor<T,R> visitor, T arg) Accepts the visitation of a visitor, which implements the CALDocCommentTextBlockVisitor interface.
CALDocComment.TextBlock	getContent()
String	toString()
void	toStringBuilder(StringBuilder result, int indentLevel) Fills the given StringBuilder with a string representation of this instance.

Methods inherited from class java.lang.Object

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

Method Detail

getContent

public CALDocComment.TextBlock getContent()

Returns:

the text block which constitute the content of this list item.

accept

public <T,R> R accept(CALDocCommentTextBlockVisitor<T,R> visitor,
                      T arg)

Accepts the visitation of a visitor, which implements the CALDocCommentTextBlockVisitor interface.

As the CALDocCommentTextBlockVisitor follows a more general visitor pattern where arguments can be passed into the visit methods and return values obtained from them, this method passes through the argument into the visit method, and returns as its return value the return value of the visit method.

Nonetheless, for a significant portion of the common cases, the state of the visitation can simply be kept as member variables within the visitor itself, thereby eliminating the need to use the argument and return value of the visit methods. In these scenarios, the recommended approach is to use Void as the type argument for both T and R, and pass in null as the argument, and return null as the return value.

Type Parameters:

T - the argument type. If the visitation argument is not used, specify Void.

R - the return type. If the return value is not used, specify Void.

Parameters:

visitor - the visitor.

arg - the argument to be passed to the visitor's visitListItem method.

Returns:

the return value of the visitor's visitListItem method.

toString

public final String toString()

Overrides:

toString in class Object

Returns:

a string representation of this instance.

toStringBuilder

public void toStringBuilder(StringBuilder result,
                            int indentLevel)

Fills the given StringBuilder with a string representation of this instance.

Parameters:

result - the StringBuilder to fill.

indentLevel - the indent level to use in indenting the generated text.