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

Class ContentElement

java.lang.Object

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

Direct Known Subclasses:

CodeBlock, FileInclusion, Instruction, Text

public abstract class ContentElement
extends java.lang.Object

Represents the content in a document that could be at either file level or section level.

Constructor Summary

Constructors

Constructor and Description
ContentElement(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.
abstract java.lang.String	getContent() Returns the content.
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

ContentElement

public ContentElement(int startIndex,
                      int endIndex,
                      DiagCollector diagCollector,
                      Location sourceLocation)

Method Detail

getContent

public abstract java.lang.String getContent()

Returns the content.

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.