Package org.asciidoctor.extension

Interface PreprocessorReader

All Superinterfaces:

Reader

public interface PreprocessorReader
extends Reader

Method Summary

Modifier and Type	Method	Description
Document	getDocument()
void	pushInclude(java.lang.String data, java.lang.String file, java.lang.String path, int lineNumber, java.util.Map<java.lang.String,java.lang.Object> attributes)	Push source content onto the front of the reader and switch the context based on the file, document-relative path and line information given.

Methods inherited from interface org.asciidoctor.extension.Reader

advance, getDir, getFile, getLineNumber, getLines, getSource, getSourceLines, hasMoreLines, isNextLineEmpty, peekLine, peekLines, read, readLine, readLines, restoreLine, restoreLines, terminate

Method Detail

pushInclude

void pushInclude(java.lang.String data,
                 java.lang.String file,
                 java.lang.String path,
                 int lineNumber,
                 java.util.Map<java.lang.String,java.lang.Object> attributes)

Push source content onto the front of the reader and switch the context based on the file, document-relative path and line information given. This method is typically used in an IncludeProcessor to add content read from the target specified.

Parameters:

data - content to push

file - representation of name of the included file. Does not need to exist

path - representation of path of the included file. Does not need to exist

lineNumber - line number of the first line of the included content

attributes - additional attributes to pass

getDocument

Document getDocument()

Returns:

Document representation.