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

Class SourceSection

java.lang.Object

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

public class SourceSection
extends java.lang.Object

Represents section in Markdown content based on Markdown header boundary.

Constructor Summary

Constructors

Constructor and Description
SourceSection(SectionHeader header, int startIndex, int endIndex, DiagCollector diagCollector, Location sourceLocation)

Method Summary

Modifier and Type	Method and Description
void	addContents(java.util.Collection<ContentElement> contents) Adds content to the section.
void	error(java.lang.String message, java.lang.Object... params) Reports error message.
java.lang.Iterable<ContentElement>	getContents() Returns contents of the section.
int	getEndIndex() The end index (exclusive) of the content the node represents from the source.
SectionHeader	getHeader() Returns header of the section.
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

SourceSection

public SourceSection(SectionHeader header,
                     int startIndex,
                     int endIndex,
                     DiagCollector diagCollector,
                     Location sourceLocation)

Method Detail

addContents

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

Adds content to the section.

getHeader

public SectionHeader getHeader()

Returns header of the section.

getContents

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

Returns contents of the section.

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.