Class AptParser
java.lang.Object
org.apache.maven.doxia.parser.AbstractParser
org.apache.maven.doxia.parser.AbstractTextParser
org.apache.maven.doxia.module.apt.AptParser
- All Implemented Interfaces:
org.apache.maven.doxia.logging.LogEnabled
,org.apache.maven.doxia.markup.Markup
,org.apache.maven.doxia.markup.TextMarkup
,AptMarkup
,org.apache.maven.doxia.parser.Parser
@Component(role=org.apache.maven.doxia.parser.Parser.class,
hint="apt")
public class AptParser
extends org.apache.maven.doxia.parser.AbstractTextParser
implements AptMarkup
The APT parser.
Based on the APTconvert project.
Based on the APTconvert project.
- Since:
- 1.0
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
a line of AptSource.protected org.apache.maven.doxia.sink.Sink
the sink to receive the events.protected String
sourceContent.protected static final char[]
An array of 85 spaces.static final int
Default tab width.Map of warn messages with a String as key to describe the error type and a Set as value.Fields inherited from interface org.apache.maven.doxia.module.apt.AptMarkup
ANCHOR_END_MARKUP, ANCHOR_START_MARKUP, BACKSLASH, BOLD_END_MARKUP, BOLD_START_MARKUP, BOXED_VERBATIM_END_MARKUP, BOXED_VERBATIM_START_MARKUP, COMMENT, HEADER_START_MARKUP, HORIZONTAL_RULE_MARKUP, ITALIC_END_MARKUP, ITALIC_START_MARKUP, LINK_END_MARKUP, LINK_START_1_MARKUP, LINK_START_2_MARKUP, LIST_END_MARKUP, LIST_START_MARKUP, MONOSPACED_END_MARKUP, MONOSPACED_START_MARKUP, NON_BOXED_VERBATIM_END_MARKUP, NON_BOXED_VERBATIM_START_MARKUP, NON_BREAKING_SPACE_MARKUP, NUMBERING, NUMBERING_LOWER_ALPHA_CHAR, NUMBERING_LOWER_ROMAN_CHAR, NUMBERING_UPPER_ALPHA_CHAR, NUMBERING_UPPER_ROMAN_CHAR, PAGE_BREAK, PAGE_BREAK_MARKUP, PERCENT, SECTION_TITLE_START_MARKUP, TAB, TABLE_CELL_SEPARATOR_MARKUP, TABLE_COL_CENTERED_ALIGNED_MARKUP, TABLE_COL_LEFT_ALIGNED_MARKUP, TABLE_COL_RIGHT_ALIGNED_MARKUP, TABLE_ROW_SEPARATOR_MARKUP, TABLE_ROW_START_MARKUP
Fields inherited from interface org.apache.maven.doxia.markup.Markup
COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR
Fields inherited from interface org.apache.maven.doxia.parser.Parser
ROLE, TXT_TYPE, UNKNOWN_TYPE, XML_TYPE
Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup
PIPE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected static char
Returns the character at position i of the given string.protected void
doTraverseText
(String text, int begin, int end, org.apache.maven.doxia.sink.Sink sink) Parse the given text.int
Returns the current line number of the Apt source document.Returns the name of the Apt source document.protected void
init()
protected void
nextLine()
Parse the next line of the Apt source document.void
void
protected static String
replaceAll
(String string, String oldSub, String newSub) Replace part of a string.protected static int
Skip spaces.Methods inherited from class org.apache.maven.doxia.parser.AbstractTextParser
getType
Methods inherited from class org.apache.maven.doxia.parser.AbstractParser
doxiaVersion, enableLogging, executeMacro, getBasedir, getLog, getMacroManager, isEmitComments, isSecondParsing, parse, setEmitComments, setSecondParsing
-
Field Details
-
SPACES
protected static final char[] SPACESAn array of 85 spaces. -
TAB_WIDTH
public static final int TAB_WIDTHDefault tab width.- See Also:
-
sourceContent
sourceContent. -
sink
protected org.apache.maven.doxia.sink.Sink sinkthe sink to receive the events. -
line
a line of AptSource. -
warnMessages
Map of warn messages with a String as key to describe the error type and a Set as value. Using to reduce warn messages.
-
-
Constructor Details
-
AptParser
public AptParser()
-
-
Method Details
-
parse
public void parse(Reader source, org.apache.maven.doxia.sink.Sink sink) throws org.apache.maven.doxia.parser.ParseException - Specified by:
parse
in interfaceorg.apache.maven.doxia.parser.Parser
- Throws:
org.apache.maven.doxia.parser.ParseException
-
parse
public void parse(Reader source, org.apache.maven.doxia.sink.Sink sink, String reference) throws org.apache.maven.doxia.parser.ParseException - Specified by:
parse
in interfaceorg.apache.maven.doxia.parser.Parser
- Overrides:
parse
in classorg.apache.maven.doxia.parser.AbstractParser
- Throws:
org.apache.maven.doxia.parser.ParseException
-
getSourceName
Returns the name of the Apt source document.- Returns:
- the source name.
-
getSourceLineNumber
public int getSourceLineNumber()Returns the current line number of the Apt source document.- Returns:
- the line number.
-
nextLine
Parse the next line of the Apt source document.- Throws:
AptParseException
- if something goes wrong.
-
doTraverseText
protected void doTraverseText(String text, int begin, int end, org.apache.maven.doxia.sink.Sink sink) throws AptParseException Parse the given text.- Parameters:
text
- the text to parse.begin
- offset.end
- offset.sink
- the sink to receive the events.- Throws:
AptParseException
- if something goes wrong.
-
charAt
Returns the character at position i of the given string.- Parameters:
string
- the string.length
- length.i
- offset.- Returns:
- the character, or '\0' if i > length.
-
skipSpace
Skip spaces.- Parameters:
string
- string.length
- length.i
- offset.- Returns:
- int.
-
replaceAll
Replace part of a string.- Parameters:
string
- the stringoldSub
- the substring to replacenewSub
- the replacement string- Returns:
- String
-
init
protected void init()- Overrides:
init
in classorg.apache.maven.doxia.parser.AbstractParser
-