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

Class SectionHeader

java.lang.Object

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

public class SectionHeader
extends java.lang.Object

Represent the header of a section.

Constructor Summary

Constructors

Constructor and Description
SectionHeader(int level, java.lang.String text, 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.
int	getEndIndex() The end index (exclusive) of the content the node represents from the source.
int	getLevel() Returns the heading level.
int	getStartIndex() The start index (inclusive) of the content the node represents from the source.
java.lang.String	getText() Returns the header text.

Methods inherited from class java.lang.Object

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

Constructor Detail

SectionHeader

public SectionHeader(int level,
                     java.lang.String text,
                     int startIndex,
                     int endIndex,
                     DiagCollector diagCollector,
                     Location sourceLocation)

Method Detail

getLevel

public int getLevel()

Returns the heading level.

getText

public java.lang.String getText()

Returns the header text.

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.