org.asciidoctor.extension

Interface Reader

All Known Subinterfaces:

PreprocessorReader

public interface Reader

Method Summary

Methods

Modifier and Type	Method and Description
boolean	advance() Advance to the next line by discarding the line at the front of the stack
int	getLineno() Get the 1-based offset of the current line.
boolean	hasMoreLines() Check whether there are any lines left to read.
boolean	isNextLineEmpty() Peek at the next line and check if it's empty (i.e., whitespace only) This method Does not consume the line from the stack.
java.util.List<java.lang.String>	lines()
java.lang.String	read() Get the remaining lines of source data joined as a String.
java.util.List<java.lang.String>	readLines() Get the remaining lines of source data.
void	terminate() Public: Advance to the end of the reader, consuming all remaining lines

Method Detail

getLineno

int getLineno()

Get the 1-based offset of the current line.

Returns:

1-based offset.

hasMoreLines

boolean hasMoreLines()

Check whether there are any lines left to read. If a previous call to this method resulted in a value of false, immediately returned the cached value. Otherwise, delegate to peek_line to determine if there is a next line available.

Returns:

True if there are more lines, False if there are not.

isNextLineEmpty

boolean isNextLineEmpty()

Peek at the next line and check if it's empty (i.e., whitespace only) This method Does not consume the line from the stack.

Returns:

True if the there are no more lines or if the next line is empty

read

java.lang.String read()

Get the remaining lines of source data joined as a String. Delegates to Reader#read_lines, then joins the result.

Returns:

the lines read joined as a String

readLines

java.util.List<java.lang.String> readLines()

Get the remaining lines of source data. This method calls Reader#read_line repeatedly until all lines are consumed and returns the lines as a String Array. This method differs from Reader#lines in that it processes each line in turn, hence triggering any preprocessors implemented in sub-classes.

Returns:

the lines read as a String Array

lines

java.util.List<java.lang.String> lines()

advance

boolean advance()

Advance to the next line by discarding the line at the front of the stack

Returns:

a Boolean indicating whether there was a line to discard.

terminate

void terminate()

Public: Advance to the end of the reader, consuming all remaining lines