A

anchor(String) - Method in class org.apache.maven.doxia.module.apt.AptSink

anchor_() - Method in class org.apache.maven.doxia.module.apt.AptSink

ANCHOR_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the anchor end: "}"

ANCHOR_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the anchor start: "{"

AptMarkup - Interface in org.apache.maven.doxia.module.apt

This interface defines all markups and syntaxes used by the APT format.

AptParseException - Exception in org.apache.maven.doxia.module.apt

Wraps an exception when parsing apt source documents.

AptParseException(String) - Constructor for exception org.apache.maven.doxia.module.apt.AptParseException

Construct a new AptParseException with the specified detail message.

AptParseException(String, Exception) - Constructor for exception org.apache.maven.doxia.module.apt.AptParseException

Construct a new AptParseException with the specified detail message and cause.

AptParseException(String, Exception, String, int, int) - Constructor for exception org.apache.maven.doxia.module.apt.AptParseException

Construct a new AptParseException with the specified cause, detail message, filename, line number and column number.

AptParseException(String, Exception, int, int) - Constructor for exception org.apache.maven.doxia.module.apt.AptParseException

Construct a new AptParseException with the specified detail message and cause.

AptParser - Class in org.apache.maven.doxia.module.apt

The APT parser.

AptParser() - Constructor for class org.apache.maven.doxia.module.apt.AptParser

 

AptParserModule - Class in org.apache.maven.doxia.module.apt

AptParserModule class.

AptParserModule() - Constructor for class org.apache.maven.doxia.module.apt.AptParserModule

Default constructor.

AptReaderSource - Class in org.apache.maven.doxia.module.apt

Reader for apt source documents.

AptReaderSource(Reader) - Constructor for class org.apache.maven.doxia.module.apt.AptReaderSource

Constructor: initialize reader.

AptReaderSource(Reader, String) - Constructor for class org.apache.maven.doxia.module.apt.AptReaderSource

Constructor: initialize reader.

AptSink - Class in org.apache.maven.doxia.module.apt

APT generator implementation.

AptSink(Writer) - Constructor for class org.apache.maven.doxia.module.apt.AptSink

Constructor, initialize the Writer and the variables.

AptSinkFactory - Class in org.apache.maven.doxia.module.apt

APT implementation of the Sink factory.

AptSinkFactory() - Constructor for class org.apache.maven.doxia.module.apt.AptSinkFactory

 

AptSiteModule - Class in org.apache.maven.doxia.module.apt

AptSiteModule class.

AptSiteModule() - Constructor for class org.apache.maven.doxia.module.apt.AptSiteModule

Default constructor.

AptSource - Interface in org.apache.maven.doxia.module.apt

An interface to read apt source documents.

AptUtils - Class in org.apache.maven.doxia.module.apt

A collection of utility methods for dealing with APT documents.

author_() - Method in class org.apache.maven.doxia.module.apt.AptSink

B

BACKSLASH - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

APT backslash markup char: '\\'

bold() - Method in class org.apache.maven.doxia.module.apt.AptSink

bold_() - Method in class org.apache.maven.doxia.module.apt.AptSink

BOLD_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the bold style end: ">>"

BOLD_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the bold style start: "<<"

BOXED_VERBATIM_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the boxed verbatim end: "+------+"

BOXED_VERBATIM_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the boxed verbatim start: "+------+"

C

charAt(String, int, int) - Static method in class org.apache.maven.doxia.module.apt.AptParser

Returns the character at position i of the given string.

close() - Method in class org.apache.maven.doxia.module.apt.AptReaderSource

Closes the reader associated with this AptReaderSource.

close() - Method in class org.apache.maven.doxia.module.apt.AptSink

COMMENT - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

APT comment markup char: '~'

comment(String) - Method in class org.apache.maven.doxia.module.apt.AptSink

content(String) - Method in class org.apache.maven.doxia.module.apt.AptSink

Write Apt escaped text to output.

createSink(Writer, String) - Method in class org.apache.maven.doxia.module.apt.AptSinkFactory

D

date_() - Method in class org.apache.maven.doxia.module.apt.AptSink

definedTerm() - Method in class org.apache.maven.doxia.module.apt.AptSink

definedTerm_() - Method in class org.apache.maven.doxia.module.apt.AptSink

definition() - Method in class org.apache.maven.doxia.module.apt.AptSink

definition_() - Method in class org.apache.maven.doxia.module.apt.AptSink

definitionList() - Method in class org.apache.maven.doxia.module.apt.AptSink

definitionList_() - Method in class org.apache.maven.doxia.module.apt.AptSink

doTraverseText(String, int, int, Sink) - Method in class org.apache.maven.doxia.module.apt.AptParser

Parse the given text.

E

encodeAnchor(String) - Static method in class org.apache.maven.doxia.module.apt.AptUtils

Construct a valid anchor.

encodeFragment(String) - Static method in class org.apache.maven.doxia.module.apt.AptUtils

Deprecated.

This method was used for the original apt format, which removed all non alphanumeric characters from anchors. Use AptUtils.encodeAnchor(String) instead.

F

figureCaption_() - Method in class org.apache.maven.doxia.module.apt.AptSink

figureGraphics(String) - Method in class org.apache.maven.doxia.module.apt.AptSink

flush() - Method in class org.apache.maven.doxia.module.apt.AptSink

G

getBuffer() - Method in class org.apache.maven.doxia.module.apt.AptSink

Returns the buffer that holds the current text.

getLineNumber() - Method in class org.apache.maven.doxia.module.apt.AptReaderSource

Gets the current line number while parsing the document.

getLineNumber() - Method in interface org.apache.maven.doxia.module.apt.AptSource

Gets the current line number while parsing the document.

getName() - Method in class org.apache.maven.doxia.module.apt.AptReaderSource

Returns the name the apt source document.

getName() - Method in interface org.apache.maven.doxia.module.apt.AptSource

Returns the name the apt source document.

getNextLine() - Method in class org.apache.maven.doxia.module.apt.AptReaderSource

Returns a line of the apt source document.

getNextLine() - Method in interface org.apache.maven.doxia.module.apt.AptSource

Returns a line of the apt source document.

getSourceLineNumber() - Method in class org.apache.maven.doxia.module.apt.AptParser

Returns the current line number of the Apt source document.

getSourceName() - Method in class org.apache.maven.doxia.module.apt.AptParser

Returns the name of the Apt source document.

H

head() - Method in class org.apache.maven.doxia.module.apt.AptSink

head_() - Method in class org.apache.maven.doxia.module.apt.AptSink

HEADER_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the header start: " -----"

HORIZONTAL_RULE_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the horizontal rule: "========"

horizontalRule() - Method in class org.apache.maven.doxia.module.apt.AptSink

I

init() - Method in class org.apache.maven.doxia.module.apt.AptParser

init() - Method in class org.apache.maven.doxia.module.apt.AptSink

isExternalLink(String) - Static method in class org.apache.maven.doxia.module.apt.AptUtils

Checks if the given string corresponds to an external URI, ie is not a link within the same document nor a link to another document within the same site.

isInternalLink(String) - Static method in class org.apache.maven.doxia.module.apt.AptUtils

Checks if the given string corresponds to an internal link, ie it is a link to an anchor within the same document.

isLocalLink(String) - Static method in class org.apache.maven.doxia.module.apt.AptUtils

Checks if the given string corresponds to a relative link to another document within the same site.

italic() - Method in class org.apache.maven.doxia.module.apt.AptSink

italic_() - Method in class org.apache.maven.doxia.module.apt.AptSink

ITALIC_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the italic style end: ">"

ITALIC_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the italic style start: "<"

L

line - Variable in class org.apache.maven.doxia.module.apt.AptParser

a line of AptSource.

lineBreak() - Method in class org.apache.maven.doxia.module.apt.AptSink

link(String) - Method in class org.apache.maven.doxia.module.apt.AptSink

link(String, String) - Method in class org.apache.maven.doxia.module.apt.AptSink

A link with a target.

link_() - Method in class org.apache.maven.doxia.module.apt.AptSink

LINK_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the link end: "}}"

LINK_START_1_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the link start: "{{{"

LINK_START_2_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the link start: "}"

linkToKey(String) - Static method in class org.apache.maven.doxia.module.apt.AptUtils

Deprecated.

This method was used for the original apt format, which removed all non alphanumeric characters from anchors. Use AptUtils.encodeAnchor(String) instead.

list() - Method in class org.apache.maven.doxia.module.apt.AptSink

list_() - Method in class org.apache.maven.doxia.module.apt.AptSink

LIST_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the list end: "[]"

LIST_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the list start: "*"

listItem() - Method in class org.apache.maven.doxia.module.apt.AptSink

listItem_() - Method in class org.apache.maven.doxia.module.apt.AptSink

M

monospaced() - Method in class org.apache.maven.doxia.module.apt.AptSink

monospaced_() - Method in class org.apache.maven.doxia.module.apt.AptSink

MONOSPACED_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the mono-spaced style end: ">>>"

MONOSPACED_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the mono-spaced style start: "<<<"

N

nextLine() - Method in class org.apache.maven.doxia.module.apt.AptParser

Parse the next line of the Apt source document.

NON_BOXED_VERBATIM_END_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the non boxed verbatim end: "------"

NON_BOXED_VERBATIM_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the non boxed verbatim start: "------"

NON_BREAKING_SPACE_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the non breaking space: "\ "

nonBreakingSpace() - Method in class org.apache.maven.doxia.module.apt.AptSink

numberedList(int) - Method in class org.apache.maven.doxia.module.apt.AptSink

numberedList_() - Method in class org.apache.maven.doxia.module.apt.AptSink

numberedListItem() - Method in class org.apache.maven.doxia.module.apt.AptSink

numberedListItem_() - Method in class org.apache.maven.doxia.module.apt.AptSink

NUMBERING - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

APT numbering decimal markup char: '1'

NUMBERING_LOWER_ALPHA_CHAR - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

APT numbering lower alpha markup char: 'a'

NUMBERING_LOWER_ROMAN_CHAR - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

APT numbering lower roman markup char: 'i'

NUMBERING_UPPER_ALPHA_CHAR - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

APT numbering upper alpha markup char: 'A'

NUMBERING_UPPER_ROMAN_CHAR - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

APT numbering upper roman markup char: 'I'

O

org.apache.maven.doxia.module.apt - package org.apache.maven.doxia.module.apt

 

P

PAGE_BREAK - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

APT page break markup char: '\f'

PAGE_BREAK_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the page break: "\f"

pageBreak() - Method in class org.apache.maven.doxia.module.apt.AptSink

paragraph() - Method in class org.apache.maven.doxia.module.apt.AptSink

paragraph_() - Method in class org.apache.maven.doxia.module.apt.AptSink

parse(Reader, Sink) - Method in class org.apache.maven.doxia.module.apt.AptParser

PERCENT - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

APT percent markup char: '%'

R

rawText(String) - Method in class org.apache.maven.doxia.module.apt.AptSink

replaceAll(String, String, String) - Static method in class org.apache.maven.doxia.module.apt.AptParser

Replace part of a string.

resetBuffer() - Method in class org.apache.maven.doxia.module.apt.AptSink

Reset the StringBuilder.

resetState() - Method in class org.apache.maven.doxia.module.apt.AptSink

Deprecated.

since 1.1.2, use AptSink.init() instead of.

resetTableCaptionBuffer() - Method in class org.apache.maven.doxia.module.apt.AptSink

Reset the TableCaptionBuffer.

S

section1_() - Method in class org.apache.maven.doxia.module.apt.AptSink

section2_() - Method in class org.apache.maven.doxia.module.apt.AptSink

section3_() - Method in class org.apache.maven.doxia.module.apt.AptSink

section4_() - Method in class org.apache.maven.doxia.module.apt.AptSink

section5_() - Method in class org.apache.maven.doxia.module.apt.AptSink

SECTION_TITLE_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the section title start: "*"

sectionTitle1() - Method in class org.apache.maven.doxia.module.apt.AptSink

sectionTitle1_() - Method in class org.apache.maven.doxia.module.apt.AptSink

sectionTitle2() - Method in class org.apache.maven.doxia.module.apt.AptSink

sectionTitle2_() - Method in class org.apache.maven.doxia.module.apt.AptSink

sectionTitle3() - Method in class org.apache.maven.doxia.module.apt.AptSink

sectionTitle3_() - Method in class org.apache.maven.doxia.module.apt.AptSink

sectionTitle4() - Method in class org.apache.maven.doxia.module.apt.AptSink

sectionTitle4_() - Method in class org.apache.maven.doxia.module.apt.AptSink

sectionTitle5() - Method in class org.apache.maven.doxia.module.apt.AptSink

sectionTitle5_() - Method in class org.apache.maven.doxia.module.apt.AptSink

setHeadFlag(boolean) - Method in class org.apache.maven.doxia.module.apt.AptSink

Used to determine whether we are in head mode.

sink - Variable in class org.apache.maven.doxia.module.apt.AptParser

the sink to receive the events.

skipSpace(String, int, int) - Static method in class org.apache.maven.doxia.module.apt.AptParser

Skip spaces.

sourceContent - Variable in class org.apache.maven.doxia.module.apt.AptParser

sourceContent.

SPACES - Static variable in class org.apache.maven.doxia.module.apt.AptParser

An array of 85 spaces.

T

TAB - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

APT tab markup char: '\t'

TAB_WIDTH - Static variable in class org.apache.maven.doxia.module.apt.AptParser

Default tab width.

table() - Method in class org.apache.maven.doxia.module.apt.AptSink

table_() - Method in class org.apache.maven.doxia.module.apt.AptSink

TABLE_CELL_SEPARATOR_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the table cell start: "|"

TABLE_COL_CENTERED_ALIGNED_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the table column, centered style: "-*"

TABLE_COL_LEFT_ALIGNED_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the table column, left style: "-+"

TABLE_COL_RIGHT_ALIGNED_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the table column, right style: "-:"

TABLE_ROW_SEPARATOR_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the table row end: "|"

TABLE_ROW_START_MARKUP - Static variable in interface org.apache.maven.doxia.module.apt.AptMarkup

Syntax for the table row start: "*--"

tableCaption() - Method in class org.apache.maven.doxia.module.apt.AptSink

tableCaption_() - Method in class org.apache.maven.doxia.module.apt.AptSink

tableCell() - Method in class org.apache.maven.doxia.module.apt.AptSink

tableCell(boolean) - Method in class org.apache.maven.doxia.module.apt.AptSink

Starts a table cell.

tableCell_() - Method in class org.apache.maven.doxia.module.apt.AptSink

tableHeaderCell() - Method in class org.apache.maven.doxia.module.apt.AptSink

tableHeaderCell_() - Method in class org.apache.maven.doxia.module.apt.AptSink

tableRow() - Method in class org.apache.maven.doxia.module.apt.AptSink

tableRow_() - Method in class org.apache.maven.doxia.module.apt.AptSink

tableRows(int[], boolean) - Method in class org.apache.maven.doxia.module.apt.AptSink

tableRows_() - Method in class org.apache.maven.doxia.module.apt.AptSink

text(String) - Method in class org.apache.maven.doxia.module.apt.AptSink

title_() - Method in class org.apache.maven.doxia.module.apt.AptSink

U

unknown(String, Object[], SinkEventAttributes) - Method in class org.apache.maven.doxia.module.apt.AptSink

Unkown events just log a warning message but are ignored otherwise.

V

verbatim(boolean) - Method in class org.apache.maven.doxia.module.apt.AptSink

verbatim_() - Method in class org.apache.maven.doxia.module.apt.AptSink

verbatimContent(String) - Method in class org.apache.maven.doxia.module.apt.AptSink

Write Apt escaped text to output.

W

warnMessages - Variable in class org.apache.maven.doxia.module.apt.AptParser

Map of warn messages with a String as key to describe the error type and a Set as value.

write(String) - Method in class org.apache.maven.doxia.module.apt.AptSink

Write text to output.