org.asciidoctor

Class RedPenTreeProcessor.BlockAccessor

java.lang.Object

org.asciidoctor.RedPenTreeProcessor.BlockAccessor

Enclosing class:

RedPenTreeProcessor

protected static class RedPenTreeProcessor.BlockAccessor
extends Object

helper class to inspect and access important asciidoctor information obscured by JRuby (and AsciiDoctorJ)

Constructor Summary

Constructors

Constructor and Description
BlockAccessor(Object aBlock) This method takes an AsciiDoctorJ JRuby object which should be an instance of an abstract block.

Method Summary

Modifier and Type	Method and Description
int	getIndent() If the underlying JRuby object is a list item, then this variable is the indent of that list item.
int	getLineNo() This returned the line number stored inside the JRuby object.
String	getSourceText() The source text is a new block element inserted into the JRuby object by the Ruby code in redpen's AsciiDocParser.java.
String	getType() The type element of the var table returns the type of this block, for example 'ulist' or 'list_time'
String	getValue() The block's value is usually its processed or converted text form

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockAccessor

public BlockAccessor(Object aBlock)

This method takes an AsciiDoctorJ JRuby object which should be an instance of an abstract block. We are attempting to get access to the underlying varTable element, which is an array of public variables stored in the JRuby object.

Parameters:

aBlock - an AsciiDoctorJ block

Method Detail

getType

public String getType()

The type element of the var table returns the type of this block, for example 'ulist' or 'list_time'

Returns:

the type of the block

getValue

public String getValue()

The block's value is usually its processed or converted text form

Returns:

the block's value

getIndent

public int getIndent()

If the underlying JRuby object is a list item, then this variable is the indent of that list item.

Returns:

the indent level of the list item

getSourceText

public String getSourceText()

The source text is a new block element inserted into the JRuby object by the Ruby code in redpen's AsciiDocParser.java. Though some blocks store the source code line alongside the processed line, certain blocks, such as list blocks, do not. Therefore the JRuby parser's list processor is overriden in redpen's AsciiDocParser.java to store the source text in a member variable. In future, we might be able to replace the other mechanisms we use to find source lines, for example header source lines, with this new mechanism.

Returns:

the source text for the block, before processing

getLineNo

public int getLineNo()

This returned the line number stored inside the JRuby object. The line number is stored as a file 'cursor', which is in itself a varTable. The line number is the third element of that table.

Returns:

the line number the block starts at