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

Class SourceRoot

java.lang.Object

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

public class SourceRoot
extends java.lang.Object

Root of the Markdown source structure based on Markdown heading levels. Header and associated contents compose a SourceSection. A document root can contain top level contents that are not enclosed by any headers. For example:

   Top Level content.
   # Header1
 

Constructor Summary

Constructors

Constructor and Description
SourceRoot(int startIndex, int endIndex, DiagCollector diagCollector, Location sourceLocation)

Method Summary

Modifier and Type	Method and Description
void	addSection(SourceSection section) Add a section to the document.
void	addTopLevelContents(java.util.Collection<ContentElement> contents) Add top level contents to the document.
void	error(java.lang.String message, java.lang.Object... params) Reports error message.
int	getEndIndex() The end index (exclusive) of the content the node represents from the source.
java.lang.Iterable<SourceSection>	getSections() Returns sections of the document.
int	getStartIndex() The start index (inclusive) of the content the node represents from the source.
java.lang.Iterable<ContentElement>	getTopLevelContents() Returns top level contents of the document.

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceRoot

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

Method Detail

addTopLevelContents

public void addTopLevelContents(java.util.Collection<ContentElement> contents)

Add top level contents to the document.

addSection

public void addSection(SourceSection section)

Add a section to the document.

getTopLevelContents

public java.lang.Iterable<ContentElement> getTopLevelContents()

Returns top level contents of the document.

getSections

public java.lang.Iterable<SourceSection> getSections()

Returns sections of the document.

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.