org.openquark.cal.compiler
Class CALDocComment.FunctionOrClassMethodLinkSegment

java.lang.Object
  org.openquark.cal.compiler.CALDocComment.Segment
      org.openquark.cal.compiler.CALDocComment.InlineTagSegment
          org.openquark.cal.compiler.CALDocComment.LinkSegment
              org.openquark.cal.compiler.CALDocComment.ScopedEntityLinkSegment
                  org.openquark.cal.compiler.CALDocComment.FunctionOrClassMethodLinkSegment

Enclosing class:

CALDocComment

public static final class CALDocComment.FunctionOrClassMethodLinkSegment
extends CALDocComment.ScopedEntityLinkSegment

Represents an inline, hyperlinkable cross-reference to a function or class method in a CALDoc comment.

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.
void	toStringBuilder(StringBuilder result, int indentLevel) Fills the given StringBuilder with a string representation of this instance.

Methods inherited from class org.openquark.cal.compiler.CALDocComment.ScopedEntityLinkSegment

getReference

Methods inherited from class org.openquark.cal.compiler.CALDocComment.Segment

toString

Methods inherited from class java.lang.Object

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

Method Detail

accept

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

Accepts the visitation of a visitor, which implements the CALDocCommentTextBlockVisitor interface. This abstract method is to be overridden by each concrete subclass so that the correct visit method on the visitor may be called based upon the type of the element being visited.

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.

Specified by:

accept in class CALDocComment.Segment

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 visitXXX method.

Returns:

the return value of the visitor's visitXXX method.

toStringBuilder

public void toStringBuilder(StringBuilder result,
                            int indentLevel)

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

Specified by:

toStringBuilder in class CALDocComment.Segment

Parameters:

result - the StringBuilder to fill.

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