Package org.asciidoctor.extension

Interface PreprocessorReader

All Superinterfaces:

Reader

All Known Implementing Classes:

PreprocessorReaderImpl

public interface PreprocessorReader
extends Reader

Method Summary

Modifier and Type	Method	Description
Document	document()	Deprecated. Please use getDocument()
Document	getDocument()
void	push_include(java.lang.String data, java.lang.String file, java.lang.String path, int lineNumber, java.util.Map<java.lang.String,java.lang.Object> attributes)	Deprecated. Use pushInclude(String, String, String, int, Map) instead.
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, getLineno, getLineNumber, hasMoreLines, isNextLineEmpty, lines, peekLine, peekLines, read, readLine, readLines, restoreLine, restoreLines, terminate

Method Detail

push_include

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

Deprecated.

Use pushInclude(String, String, String, int, Map) instead.

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 exists

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

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

attributes - additional attributes to pass

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 exists

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

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

attributes - additional attributes to pass

document

@Deprecated
Document document()

Deprecated.

Please use getDocument()

Returns:

Document representation.

getDocument

Document getDocument()

Returns:

Document representation.