com.google.api.tools.framework.aspects.documentation.source

Class Instruction

java.lang.Object

com.google.api.tools.framework.aspects.documentation.source.ContentElement

com.google.api.tools.framework.aspects.documentation.source.Instruction

public class Instruction
extends ContentElement

Represents Docgen instructions other than file inclusion: (== code arg ==)

Constructor Summary

Constructors

Constructor and Description
Instruction(java.lang.String code, java.lang.String arg, int startIndex, int endIndex, DiagCollector diagCollector, Location sourceLocation)

Method Summary

Modifier and Type	Method and Description
void	error(java.lang.String message, java.lang.Object... params) Reports error message.
void	evalute(Element element) Evaluate the instruction in context of given element.
java.lang.String	getArg() Returns the instruction argument.
java.lang.String	getCode() Returns the instruction code
java.lang.String	getContent() Return the content (empty for instruction).
int	getEndIndex() The end index (exclusive) of the content the node represents from the source.
int	getStartIndex() The start index (inclusive) of the content the node represents from the source.

Methods inherited from class java.lang.Object

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

Constructor Detail

Instruction

public Instruction(java.lang.String code,
                   java.lang.String arg,
                   int startIndex,
                   int endIndex,
                   DiagCollector diagCollector,
                   Location sourceLocation)

Method Detail

getCode

public java.lang.String getCode()

Returns the instruction code

getArg

public java.lang.String getArg()

Returns the instruction argument.

getContent

public java.lang.String getContent()

Return the content (empty for instruction).

Specified by:

getContent in class ContentElement

evalute

public void evalute(Element element)

Evaluate the instruction in context of given element.

getStartIndex

public int getStartIndex()

The start index (inclusive) of the content the node represents from the source.

getEndIndex

public int getEndIndex()

The end index (exclusive) of the content the node represents from the source.

error

public void error(java.lang.String message,
                  java.lang.Object... params)

Reports error message.