org.apache.maven.doxia.module.apt

Class AptParser.Block

java.lang.Object

org.apache.maven.doxia.module.apt.AptParser.Block

Direct Known Subclasses:

AptParser.Comment, AptParser.DefinitionListItem, AptParser.Figure, AptParser.HorizontalRule, AptParser.ListBreak, AptParser.ListItem, AptParser.MacroBlock, AptParser.NumberedListItem, AptParser.PageBreak, AptParser.Paragraph, AptParser.Section, AptParser.Table, AptParser.Title, AptParser.Verbatim

Enclosing class:

AptParser

private abstract class AptParser.Block
extends java.lang.Object

A block of an apt source document.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	indent indent.
protected java.lang.String	text text.
protected int	textLength textLength.
protected int	type type.

Constructor Summary

Constructors

Constructor and Description
Block(int type, int indent) Constructor.
Block(int type, int indent, java.lang.String firstLine) Constructor.

Method Summary

Modifier and Type	Method and Description
int	getIndent() Return the block indent.
int	getType() Return the block type.
protected int	skipFromLeftToRightBracket(int i) Skip brackets.
protected int	skipLeadingBullets() Skip spaces.
protected int	skipSpaceFrom(int i) Skip spaces.
abstract void	traverse() Parse the block.
protected void	traverseText(int begin) Traverse the text.
protected void	traverseText(int begin, int end) Traverse the text.

Methods inherited from class java.lang.Object

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

Field Detail

type

protected int type

type.

indent

protected int indent

indent.

text

protected java.lang.String text

text.

textLength

protected int textLength

textLength.

Constructor Detail

Block

public Block(int type,
             int indent)
      throws AptParseException

Constructor.

Parameters:

type - the block type.

indent - indent.

Throws:

AptParseException - AptParseException

Block

public Block(int type,
             int indent,
             java.lang.String firstLine)
      throws AptParseException

Constructor.

Parameters:

type - type.

indent - indent.

firstLine - the first line.

Throws:

AptParseException - AptParseException

Method Detail

getType

public final int getType()

Return the block type.

Returns:

int

getIndent

public final int getIndent()

Return the block indent.

Returns:

int

traverse

public abstract void traverse()
                       throws AptParseException

Parse the block.

Throws:

AptParseException - if something goes wrong.

traverseText

protected void traverseText(int begin)
                     throws AptParseException

Traverse the text.

Parameters:

begin - offset.

Throws:

AptParseException - if something goes wrong.

traverseText

protected void traverseText(int begin,
                            int end)
                     throws AptParseException

Traverse the text.

Parameters:

begin - offset.

end - offset.

Throws:

AptParseException - if something goes wrong.

skipLeadingBullets

protected int skipLeadingBullets()

Skip spaces.

Returns:

int.

skipFromLeftToRightBracket

protected int skipFromLeftToRightBracket(int i)
                                  throws AptParseException

Skip brackets.

Parameters:

i - offset.

Returns:

int.

Throws:

AptParseException - if something goes wrong.

skipSpaceFrom

protected final int skipSpaceFrom(int i)

Skip spaces.

Parameters:

i - offset.

Returns:

int.