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

Class FileInclusion

java.lang.Object

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

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

public class FileInclusion
extends ContentElement

Represents Docgen file inclusion instruction.

Constructor Summary

Constructors

Constructor and Description
FileInclusion(java.lang.String docPath, java.lang.String relativeFilePath, int sectionLevel, 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.
java.lang.String	getContent() Returns the content of included file if file path is valid.
int	getEndIndex() The end index (exclusive) of the content the node represents from the source.
java.lang.String	getFileName() Returns the included file name.
java.lang.String	getRelativeFilePath() Returns the included file path relative to the root of data files.
int	getSectionLevel() Returns the section level the file should be included.
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

FileInclusion

public FileInclusion(java.lang.String docPath,
                     java.lang.String relativeFilePath,
                     int sectionLevel,
                     int startIndex,
                     int endIndex,
                     DiagCollector diagCollector,
                     Location sourceLocation)

Method Detail

getRelativeFilePath

public java.lang.String getRelativeFilePath()

Returns the included file path relative to the root of data files.

getFileName

public java.lang.String getFileName()

Returns the included file name.

getContent

@Nullable
public java.lang.String getContent()

Returns the content of included file if file path is valid. Otherwise, returns null.

Specified by:

getContent in class ContentElement

getSectionLevel

public int getSectionLevel()

Returns the section level the file should be included.

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.