org.asciidoctor.extension

Class ReaderImpl

java.lang.Object

org.asciidoctor.internal.RubyObjectWrapper

org.asciidoctor.extension.ReaderImpl

All Implemented Interfaces:

Reader

Direct Known Subclasses:

PreprocessorReaderImpl

public class ReaderImpl
extends RubyObjectWrapper
implements Reader

Field Summary

Fields inherited from class org.asciidoctor.internal.RubyObjectWrapper

rubyNode, runtime

Constructor Summary

Constructors

Constructor and Description
ReaderImpl(org.jruby.runtime.builtin.IRubyObject rubyNode)

Method Summary

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.
int	getLineNumber() 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	peekLine() Peek at the next line of source data.
java.util.List<java.lang.String>	peekLines(int lineCount) Peek at the next multiple lines of source data.
java.lang.String	read() Get the remaining lines of source data joined as a String.
java.lang.String	readLine() Get the next line of source data.
java.util.List<java.lang.String>	readLines() Get the remaining lines of source data.
void	restoreLine(java.lang.String line) Push the String line onto the beginning of the Array of source data.
void	restoreLines(java.util.List<java.lang.String> lines) Push multiple lines onto the beginning of the Array of source data.
void	terminate() Public: Advance to the end of the reader, consuming all remaining lines

Methods inherited from class org.asciidoctor.internal.RubyObjectWrapper

getBoolean, getInt, getList, getProperty, getRubyObject, getRubyProperty, getRuntime, getString, getSymbol, setRubyProperty, setString, setSymbol, toJava, toJava

Methods inherited from class java.lang.Object

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

Constructor Detail

ReaderImpl

public ReaderImpl(org.jruby.runtime.builtin.IRubyObject rubyNode)

Method Detail

getLineno

public int getLineno()

Description copied from interface: Reader

Get the 1-based offset of the current line.

Specified by:

getLineno in interface Reader

Returns:

1-based offset.

getLineNumber

public int getLineNumber()

Description copied from interface: Reader

Get the 1-based offset of the current line.

Specified by:

getLineNumber in interface Reader

Returns:

1-based offset.

hasMoreLines

public boolean hasMoreLines()

Description copied from interface: Reader

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.

Specified by:

hasMoreLines in interface Reader

Returns:

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

isNextLineEmpty

public boolean isNextLineEmpty()

Description copied from interface: Reader

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.

Specified by:

isNextLineEmpty in interface Reader

Returns:

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

read

public java.lang.String read()

Description copied from interface: Reader

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

Specified by:

read in interface Reader

Returns:

the lines read joined as a String

readLines

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

Description copied from interface: Reader

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.

Specified by:

readLines in interface Reader

Returns:

the lines read as a String Array

readLine

public java.lang.String readLine()

Description copied from interface: Reader

Get the next line of source data. Consumes the line returned.

Specified by:

readLine in interface Reader

Returns:

the String of the next line of the source data if data is present or nulll if there is no more data.

lines

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

Specified by:

lines in interface Reader

restoreLine

public void restoreLine(java.lang.String line)

Description copied from interface: Reader

Push the String line onto the beginning of the Array of source data. Since this line was (assumed to be) previously retrieved through the reader, it is marked as seen.

Specified by:

restoreLine in interface Reader

restoreLines

public void restoreLines(java.util.List<java.lang.String> lines)

Description copied from interface: Reader

Push multiple lines onto the beginning of the Array of source data. Since this lines were (assumed to be) previously retrieved through the reader, they are marked as seen.

Specified by:

restoreLines in interface Reader

peekLine

public java.lang.String peekLine()

Description copied from interface: Reader

Peek at the next line of source data. Processes the line, if not already marked as processed, but does not consume it. This method will probe the reader for more lines.

Specified by:

peekLine in interface Reader

peekLines

public java.util.List<java.lang.String> peekLines(int lineCount)

Description copied from interface: Reader

Peek at the next multiple lines of source data. Processes the lines, if not already marked as processed, but does not consume them.

Specified by:

peekLines in interface Reader

Parameters:

lineCount - The Integer number of lines to peek.

Returns:

advance

public boolean advance()

Description copied from interface: Reader

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

Specified by:

advance in interface Reader

Returns:

a Boolean indicating whether there was a line to discard.

terminate

public void terminate()

Description copied from interface: Reader

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

Specified by:

terminate in interface Reader