A B C D E F G H I J L M N O P Q R S T U V W X

A

AbstractMacro - Class in org.apache.maven.doxia.macro

Abstract base class to execute Macro.

AbstractMacro() - Constructor for class org.apache.maven.doxia.macro.AbstractMacro

AbstractParser - Class in org.apache.maven.doxia.parser

An abstract base class that defines some convenience methods for parsers.

AbstractParser() - Constructor for class org.apache.maven.doxia.parser.AbstractParser

AbstractSiteModule - Class in org.apache.maven.doxia.module.site

An abstract base class that implements the SiteModule interface.

AbstractSiteModule() - Constructor for class org.apache.maven.doxia.module.site.AbstractSiteModule

AbstractTextParser - Class in org.apache.maven.doxia.parser

An abstract class that defines some convenience methods for Text parsers.

AbstractTextParser() - Constructor for class org.apache.maven.doxia.parser.AbstractTextParser

AbstractTextSink - Class in org.apache.maven.doxia.sink

An abstract Sink for text markup syntax.

AbstractTextSink() - Constructor for class org.apache.maven.doxia.sink.AbstractTextSink

AbstractXmlParser - Class in org.apache.maven.doxia.parser

An abstract class that defines some convenience methods for XML parsers.

AbstractXmlParser() - Constructor for class org.apache.maven.doxia.parser.AbstractXmlParser

AbstractXmlSink - Class in org.apache.maven.doxia.sink

An abstract Sink for xml markup syntax.

AbstractXmlSink() - Constructor for class org.apache.maven.doxia.sink.AbstractXmlSink

addSink(Sink) - Method in class org.apache.maven.doxia.sink.PipelineSink

anchor(String) - Method in class org.apache.maven.doxia.sink.SinkAdapter

anchor_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

author() - Method in class org.apache.maven.doxia.sink.SinkAdapter

author_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

B

BANG - Static variable in interface org.apache.maven.doxia.markup.XmlMarkup

bang character: '!'

body() - Method in class org.apache.maven.doxia.sink.SinkAdapter

body_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

bold() - Method in class org.apache.maven.doxia.sink.SinkAdapter

bold_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

ByLineReaderSource - Class in org.apache.maven.doxia.util

ByLineSource default implementation

ByLineReaderSource(Reader) - Constructor for class org.apache.maven.doxia.util.ByLineReaderSource

Creates the ByLineReaderSource.

ByLineSource - Interface in org.apache.maven.doxia.util

The token are the new lines :)

C

cacheSnippet(URL, String, String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetMacro

Puts the given snippet into the cache.

CDATA - Static variable in interface org.apache.maven.doxia.markup.XmlMarkup

CDATA string: "CDATA"

close() - Method in class org.apache.maven.doxia.sink.SinkAdapter

close() - Method in class org.apache.maven.doxia.util.ByLineReaderSource

close the source ...

close() - Method in interface org.apache.maven.doxia.util.ByLineSource

close the source ...

close() - Method in class org.apache.maven.doxia.util.LineBreaker

Close the writer.

D

date() - Method in class org.apache.maven.doxia.sink.SinkAdapter

date_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

DEFAULT_MAX_LINE_LENGTH - Static variable in class org.apache.maven.doxia.util.LineBreaker

The default maximal line length.

DefaultDoxia - Class in org.apache.maven.doxia

Simple implementation of the Doxia interface: uses a ParserManager to lookup a parser.

DefaultDoxia() - Constructor for class org.apache.maven.doxia.DefaultDoxia

DefaultMacroManager - Class in org.apache.maven.doxia.macro.manager

Default implementation of MacroManager

DefaultMacroManager() - Constructor for class org.apache.maven.doxia.macro.manager.DefaultMacroManager

DefaultParserManager - Class in org.apache.maven.doxia.parser.manager

Simple implementation of the ParserManager interface.

DefaultParserManager() - Constructor for class org.apache.maven.doxia.parser.manager.DefaultParserManager

DefaultSiteModuleManager - Class in org.apache.maven.doxia.module.site.manager

Simple implementation of the SiteModuleManager interface.

DefaultSiteModuleManager() - Constructor for class org.apache.maven.doxia.module.site.manager.DefaultSiteModuleManager

definedTerm() - Method in class org.apache.maven.doxia.sink.SinkAdapter

definedTerm_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

definition() - Method in class org.apache.maven.doxia.sink.SinkAdapter

definition_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

definitionList() - Method in class org.apache.maven.doxia.sink.SinkAdapter

definitionList_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

definitionListItem() - Method in class org.apache.maven.doxia.sink.SinkAdapter

definitionListItem_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

Doxia - Interface in org.apache.maven.doxia

Basic interface of the Doxia framework.

E

EchoMacro - Class in org.apache.maven.doxia.macro

A simple macro that prints out the key and value of some supplied parameters.

EchoMacro() - Constructor for class org.apache.maven.doxia.macro.EchoMacro

encodeFragment(String) - Static method in class org.apache.maven.doxia.util.HtmlTools

Replace all characters in a text.

encodeId(String) - Static method in class org.apache.maven.doxia.util.HtmlTools

Construct a valid id.

encodeURL(String) - Static method in class org.apache.maven.doxia.util.HtmlTools

Encode an url

EOL - Static variable in interface org.apache.maven.doxia.markup.Markup

The vm line separator

EQUAL - Static variable in interface org.apache.maven.doxia.markup.Markup

equal character: '='

escapeHTML(String) - Static method in class org.apache.maven.doxia.util.HtmlTools

Escape special characters in a text in HTML.

execute(Sink, MacroRequest) - Method in class org.apache.maven.doxia.macro.EchoMacro

Execute the current macro using the given MacroRequest, and emit events into the given sink.

execute(Sink, MacroRequest) - Method in interface org.apache.maven.doxia.macro.Macro

Execute the current macro using the given MacroRequest, and emit events into the given sink.

execute(Sink, MacroRequest) - Method in class org.apache.maven.doxia.macro.snippet.SnippetMacro

Execute the current macro using the given MacroRequest, and emit events into the given sink.

execute(Sink, MacroRequest) - Method in class org.apache.maven.doxia.macro.SwfMacro

Execute the current macro using the given MacroRequest, and emit events into the given sink.

execute(Sink, MacroRequest) - Method in class org.apache.maven.doxia.macro.toc.TocMacro

Execute the current macro using the given MacroRequest, and emit events into the given sink.

executeMacro(String, MacroRequest, Sink) - Method in class org.apache.maven.doxia.parser.AbstractParser

Execute a macro on the given sink.

F

figure() - Method in class org.apache.maven.doxia.sink.SinkAdapter

figure_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

figureCaption() - Method in class org.apache.maven.doxia.sink.SinkAdapter

figureCaption_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

figureGraphics(String) - Method in class org.apache.maven.doxia.sink.SinkAdapter

flush() - Method in class org.apache.maven.doxia.sink.SinkAdapter

flush() - Method in class org.apache.maven.doxia.util.LineBreaker

Write out the current StringBuffer and flush the writer.

G

getBasedir() - Method in class org.apache.maven.doxia.macro.MacroRequest

Returns the current base directory.

getBasedir() - Method in class org.apache.maven.doxia.parser.AbstractParser

Returns the current base directory.

getChildEntries() - Method in class org.apache.maven.doxia.index.IndexEntry

Returns an unmodifiableList of the child entries.

getDestination() - Method in class org.apache.maven.doxia.util.LineBreaker

Returns the current destination writer.

getExtension() - Method in class org.apache.maven.doxia.module.site.AbstractSiteModule

Returns the default file extension for a given module.

getExtension() - Method in interface org.apache.maven.doxia.module.site.SiteModule

Returns the default file extension for a given module.

getFileName() - Method in exception org.apache.maven.doxia.parser.ParseException

Returns the file that caused the ParseException.

getFirstEntry() - Method in class org.apache.maven.doxia.index.IndexEntry

Returns the first entry.

getId() - Method in class org.apache.maven.doxia.index.IndexEntry

Returns the id.

getLastEntry() - Method in class org.apache.maven.doxia.index.IndexEntry

Returns the last entry.

getLineNumber() - Method in exception org.apache.maven.doxia.parser.ParseException

Returns the line number where the ParseException ocurred.

getLineNumber() - Method in class org.apache.maven.doxia.util.ByLineReaderSource

getLineNumber() - Method in interface org.apache.maven.doxia.util.ByLineSource

getMacro(String) - Method in class org.apache.maven.doxia.macro.manager.DefaultMacroManager

Returns the MacroManager that corresponds to the given id.

getMacro(String) - Method in interface org.apache.maven.doxia.macro.manager.MacroManager

Returns the MacroManager that corresponds to the given id.

getName() - Method in class org.apache.maven.doxia.util.ByLineReaderSource

getName() - Method in interface org.apache.maven.doxia.util.ByLineSource

getNextEntry() - Method in class org.apache.maven.doxia.index.IndexEntry

Returns the next entry.

getNextLine() - Method in class org.apache.maven.doxia.util.ByLineReaderSource

getNextLine() - Method in interface org.apache.maven.doxia.util.ByLineSource

getParameter(String) - Method in class org.apache.maven.doxia.macro.MacroRequest

Returns on object from the map of parameters that corresponds to the given key.

getParameters() - Method in class org.apache.maven.doxia.macro.MacroRequest

Returns the map of parameters.

getParent() - Method in class org.apache.maven.doxia.index.IndexEntry

Returns the parent entry.

getParser(String) - Method in class org.apache.maven.doxia.DefaultDoxia

Return a parser for the given parserId.

getParser(String) - Method in interface org.apache.maven.doxia.Doxia

Return a parser for the given parserId.

getParser(String) - Method in class org.apache.maven.doxia.parser.manager.DefaultParserManager

Returns the parser that corresponds to the given id.

getParser(String) - Method in interface org.apache.maven.doxia.parser.manager.ParserManager

Returns the parser that corresponds to the given id.

getParserId() - Method in interface org.apache.maven.doxia.module.site.SiteModule

Returns the parser id for a given module.

getPrevEntry() - Method in class org.apache.maven.doxia.index.IndexEntry

Returns the previous entry.

getRootEntry() - Method in class org.apache.maven.doxia.index.IndexEntry

Returns the root entry.

getSiteModule(String) - Method in class org.apache.maven.doxia.module.site.manager.DefaultSiteModuleManager

Returns the SiteModule that corresponds to the given id.

getSiteModule(String) - Method in interface org.apache.maven.doxia.module.site.manager.SiteModuleManager

Returns the SiteModule that corresponds to the given id.

getSiteModules() - Method in class org.apache.maven.doxia.module.site.manager.DefaultSiteModuleManager

Returns a collection of SiteModules.

getSiteModules() - Method in interface org.apache.maven.doxia.module.site.manager.SiteModuleManager

Returns a collection of SiteModules.

getSourceDirectory() - Method in class org.apache.maven.doxia.module.site.AbstractSiteModule

Returns the directory that contains source files for a given module.

getSourceDirectory() - Method in interface org.apache.maven.doxia.module.site.SiteModule

Returns the directory that contains source files for a given module.

getTitle() - Method in class org.apache.maven.doxia.index.IndexEntry

Returns the title.

getTitle() - Method in class org.apache.maven.doxia.index.IndexingSink

getType() - Method in class org.apache.maven.doxia.parser.AbstractParser

The parser type value could be Parser.UNKNOWN_TYPE, Parser.TXT_TYPE or Parser.XML_TYPE.

getType() - Method in class org.apache.maven.doxia.parser.AbstractTextParser

The parser type value could be Parser.UNKNOWN_TYPE, Parser.TXT_TYPE or Parser.XML_TYPE.

getType() - Method in class org.apache.maven.doxia.parser.AbstractXmlParser

The parser type value could be Parser.UNKNOWN_TYPE, Parser.TXT_TYPE or Parser.XML_TYPE.

getType() - Method in interface org.apache.maven.doxia.parser.Parser

The parser type value could be Parser.UNKNOWN_TYPE, Parser.TXT_TYPE or Parser.XML_TYPE.

GREATER_THAN - Static variable in interface org.apache.maven.doxia.markup.Markup

end character: '>'

H

handleEndTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser

Goes through the possible end tags.

handleStartTag(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser

Goes through the possible start tags.

handleText(XmlPullParser, Sink) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser

Handles text events.

head() - Method in class org.apache.maven.doxia.sink.SinkAdapter

head_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

horizontalRule() - Method in class org.apache.maven.doxia.sink.SinkAdapter

HtmlTools - Class in org.apache.maven.doxia.util

The HtmlTools class defines methods to HTML handling.

HtmlTools() - Constructor for class org.apache.maven.doxia.util.HtmlTools

I

IndexEntry - Class in org.apache.maven.doxia.index

IndexEntry(String) - Constructor for class org.apache.maven.doxia.index.IndexEntry

Constructor.

IndexEntry(IndexEntry, String) - Constructor for class org.apache.maven.doxia.index.IndexEntry

Constructor.

IndexingSink - Class in org.apache.maven.doxia.index

A sink implementation for index

IndexingSink(IndexEntry) - Constructor for class org.apache.maven.doxia.index.IndexingSink

Default constructor.

invoke(Object, Method, Object[]) - Method in class org.apache.maven.doxia.sink.PipelineSink

isDemarcator(String, String, String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetReader

Determines if the given line is a demarcator.

isEnd(String, String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetReader

Determines if the given line is an end demarcator.

isExternalLink(String) - Static method in class org.apache.maven.doxia.sink.StructureSink

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

isId(String) - Static method in class org.apache.maven.doxia.util.HtmlTools

Determines if the specified text is a valid id according to the rules laid out in encodeId(String).

isStart(String, String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetReader

Determines if the given line is a start demarcator.

italic() - Method in class org.apache.maven.doxia.sink.SinkAdapter

italic_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

J

JUSTIFY_CENTER - Static variable in interface org.apache.maven.doxia.parser.Parser

Used for table cells: justify center.

JUSTIFY_LEFT - Static variable in interface org.apache.maven.doxia.parser.Parser

Used for table cells: justify left.

JUSTIFY_RIGHT - Static variable in interface org.apache.maven.doxia.parser.Parser

Used for table cells: justify right.

L

LEFT_CURLY_BRACKET - Static variable in interface org.apache.maven.doxia.markup.Markup

left curly bracket character: '{'

LEFT_SQUARE_BRACKET - Static variable in interface org.apache.maven.doxia.markup.Markup

left square bracket character: '['

LESS_THAN - Static variable in interface org.apache.maven.doxia.markup.Markup

start character: '<'

lineBreak() - Method in class org.apache.maven.doxia.sink.SinkAdapter

LineBreaker - Class in org.apache.maven.doxia.util

Allows to specify the line-length of an output writer.

LineBreaker(Writer) - Constructor for class org.apache.maven.doxia.util.LineBreaker

Constructs a new LineBreaker with DEFAULT_MAX_LINE_LENGTH.

LineBreaker(Writer, int) - Constructor for class org.apache.maven.doxia.util.LineBreaker

Constructs a new LineBreaker with the given max line length.

link(String) - Method in class org.apache.maven.doxia.sink.SinkAdapter

link_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

linkToKey(String) - Static method in class org.apache.maven.doxia.sink.StructureSink

Transforms the given text such that it can be used as a link.

list() - Method in class org.apache.maven.doxia.sink.SinkAdapter

list_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

listItem() - Method in class org.apache.maven.doxia.sink.SinkAdapter

listItem_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

M

Macro - Interface in org.apache.maven.doxia.macro

Base interface of a macro.

MacroExecutionException - Exception in org.apache.maven.doxia.macro

Wrap an exception that occurs during the execution of a Doxia macro.

MacroExecutionException(String) - Constructor for exception org.apache.maven.doxia.macro.MacroExecutionException

Construct a new MacroExecutionException with the specified detail message.

MacroExecutionException(String, Throwable) - Constructor for exception org.apache.maven.doxia.macro.MacroExecutionException

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

MacroManager - Interface in org.apache.maven.doxia.macro.manager

Handles MacroManager lookups.

macroManager - Variable in class org.apache.maven.doxia.parser.AbstractParser

MacroNotFoundException - Exception in org.apache.maven.doxia.macro.manager

Encapsulate an exception that indicates that a Macro does not exist or could not be found.

MacroNotFoundException(String) - Constructor for exception org.apache.maven.doxia.macro.manager.MacroNotFoundException

Construct a new MacroNotFoundException with the specified detail message.

MacroNotFoundException(Throwable) - Constructor for exception org.apache.maven.doxia.macro.manager.MacroNotFoundException

Constructs a new MacroNotFoundException with the specified cause.

MacroNotFoundException(String, Throwable) - Constructor for exception org.apache.maven.doxia.macro.manager.MacroNotFoundException

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

MacroRequest - Class in org.apache.maven.doxia.macro

MacroRequest(Map, File) - Constructor for class org.apache.maven.doxia.macro.MacroRequest

Constructor.

Markup - Interface in org.apache.maven.doxia.markup

List of constants used by all markup syntax.

MINUS - Static variable in interface org.apache.maven.doxia.markup.Markup

minus character: '-'

monospaced() - Method in class org.apache.maven.doxia.sink.SinkAdapter

monospaced_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

N

newInstance(List) - Static method in class org.apache.maven.doxia.sink.PipelineSink

nonBreakingSpace() - Method in class org.apache.maven.doxia.sink.SinkAdapter

numberedList(int) - Method in class org.apache.maven.doxia.sink.SinkAdapter

numberedList_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

numberedListItem() - Method in class org.apache.maven.doxia.sink.SinkAdapter

numberedListItem_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

O

org.apache.maven.doxia - package org.apache.maven.doxia

org.apache.maven.doxia.index - package org.apache.maven.doxia.index

org.apache.maven.doxia.macro - package org.apache.maven.doxia.macro

org.apache.maven.doxia.macro.manager - package org.apache.maven.doxia.macro.manager

org.apache.maven.doxia.macro.snippet - package org.apache.maven.doxia.macro.snippet

org.apache.maven.doxia.macro.toc - package org.apache.maven.doxia.macro.toc

org.apache.maven.doxia.markup - package org.apache.maven.doxia.markup

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

org.apache.maven.doxia.module.site.manager - package org.apache.maven.doxia.module.site.manager

org.apache.maven.doxia.parser - package org.apache.maven.doxia.parser

org.apache.maven.doxia.parser.manager - package org.apache.maven.doxia.parser.manager

org.apache.maven.doxia.sink - package org.apache.maven.doxia.sink

org.apache.maven.doxia.util - package org.apache.maven.doxia.util

P

pageBreak() - Method in class org.apache.maven.doxia.sink.SinkAdapter

paragraph() - Method in class org.apache.maven.doxia.sink.SinkAdapter

paragraph_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

parse(Reader, String, Sink) - Method in class org.apache.maven.doxia.DefaultDoxia

Parses the given source model using a parser with given id, and emits Doxia events into the given sink.

parse(Reader, String, Sink) - Method in interface org.apache.maven.doxia.Doxia

Parses the given source model using a parser with given id, and emits Doxia events into the given sink.

parse(Reader, Sink) - Method in class org.apache.maven.doxia.parser.AbstractXmlParser

Parses the given source model and emits Doxia events into the given sink.

parse(Reader, Sink) - Method in interface org.apache.maven.doxia.parser.Parser

Parses the given source model and emits Doxia events into the given sink.

ParseException - Exception in org.apache.maven.doxia.parser

Encapsulate a Doxia parse error.

ParseException(String) - Constructor for exception org.apache.maven.doxia.parser.ParseException

Construct a new ParseException with the specified detail message.

ParseException(String, Exception) - Constructor for exception org.apache.maven.doxia.parser.ParseException

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

ParseException(Exception) - Constructor for exception org.apache.maven.doxia.parser.ParseException

Constructs a new exception with the specified cause.

ParseException(Exception, String, int) - Constructor for exception org.apache.maven.doxia.parser.ParseException

Construct a new ParseException with the specified cause, filename and linenumber.

ParseException(Exception, String, String, int) - Constructor for exception org.apache.maven.doxia.parser.ParseException

Construct a new ParseException with the specified cause, detail message, filename and linenumber.

Parser - Interface in org.apache.maven.doxia.parser

A Parser is responsible for parsing any document in a supported front-end format, and emitting the standard Doxia events, which can then be consumed by any Doxia Sink.

ParserManager - Interface in org.apache.maven.doxia.parser.manager

Handles parser lookups.

ParserNotFoundException - Exception in org.apache.maven.doxia.parser.manager

Encapsulate a Doxia exception that indicates that a parser does not exist or could not be found.

ParserNotFoundException(String) - Constructor for exception org.apache.maven.doxia.parser.manager.ParserNotFoundException

Construct a new ParserNotFoundException with the specified detail message.

ParserNotFoundException(Throwable) - Constructor for exception org.apache.maven.doxia.parser.manager.ParserNotFoundException

Constructs a new exception with the specified cause.

ParserNotFoundException(String, Throwable) - Constructor for exception org.apache.maven.doxia.parser.manager.ParserNotFoundException

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

peek() - Method in class org.apache.maven.doxia.index.IndexingSink

PIPE - Static variable in interface org.apache.maven.doxia.markup.TextMarkup

pipe character: '|'

PipelineSink - Class in org.apache.maven.doxia.sink

PipelineSink(List) - Constructor for class org.apache.maven.doxia.sink.PipelineSink

PLUS - Static variable in interface org.apache.maven.doxia.markup.Markup

plus character: '+'

pop() - Method in class org.apache.maven.doxia.index.IndexingSink

Removes the IndexEntry at the top of this stack

push(IndexEntry) - Method in class org.apache.maven.doxia.index.IndexingSink

Pushes an IndexEntry onto the top of this stack

Q

QUOTE - Static variable in interface org.apache.maven.doxia.markup.Markup

double quote character: '\"'

R

rawText(String) - Method in class org.apache.maven.doxia.sink.SinkAdapter

readSnippet(String) - Method in class org.apache.maven.doxia.macro.snippet.SnippetReader

Reads the snippet with given id.

RIGHT_CURLY_BRACKET - Static variable in interface org.apache.maven.doxia.markup.Markup

right curly bracket character: '}'

RIGHT_SQUARE_BRACKET - Static variable in interface org.apache.maven.doxia.markup.Markup

right square bracket character: ']'

ROLE - Static variable in interface org.apache.maven.doxia.Doxia

The Plexus lookup role.

ROLE - Static variable in interface org.apache.maven.doxia.macro.Macro

The Plexus lookup role.

ROLE - Static variable in interface org.apache.maven.doxia.macro.manager.MacroManager

The Plexus lookup role.

ROLE - Static variable in interface org.apache.maven.doxia.module.site.manager.SiteModuleManager

The Plexus lookup role.

ROLE - Static variable in interface org.apache.maven.doxia.module.site.SiteModule

The Plexus lookup role.

ROLE - Static variable in interface org.apache.maven.doxia.parser.manager.ParserManager

The Plexus lookup role.

ROLE - Static variable in interface org.apache.maven.doxia.parser.Parser

The Plexus lookup role.

S

secondParsing - Variable in class org.apache.maven.doxia.parser.AbstractParser

Indicates that a second parsing is required.

section1() - Method in class org.apache.maven.doxia.sink.SinkAdapter

section1_() - Method in class org.apache.maven.doxia.index.IndexingSink

section1_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

section2() - Method in class org.apache.maven.doxia.sink.SinkAdapter

section2_() - Method in class org.apache.maven.doxia.index.IndexingSink

section2_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

section3() - Method in class org.apache.maven.doxia.sink.SinkAdapter

section3_() - Method in class org.apache.maven.doxia.index.IndexingSink

section3_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

section4() - Method in class org.apache.maven.doxia.sink.SinkAdapter

section4_() - Method in class org.apache.maven.doxia.index.IndexingSink

section4_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

section5() - Method in class org.apache.maven.doxia.sink.SinkAdapter

section5_() - Method in class org.apache.maven.doxia.index.IndexingSink

section5_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle() - Method in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle1() - Method in class org.apache.maven.doxia.index.IndexingSink

sectionTitle1() - Method in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle1_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle2() - Method in class org.apache.maven.doxia.index.IndexingSink

sectionTitle2() - Method in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle2_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle3() - Method in class org.apache.maven.doxia.index.IndexingSink

sectionTitle3() - Method in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle3_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle4() - Method in class org.apache.maven.doxia.index.IndexingSink

sectionTitle4() - Method in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle4_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle5() - Method in class org.apache.maven.doxia.index.IndexingSink

sectionTitle5() - Method in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle5_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

setBasedir(File) - Method in class org.apache.maven.doxia.macro.MacroRequest

Sets the current base directory.

setCacheTimeout(int) - Method in class org.apache.maven.doxia.macro.snippet.SnippetMacro

Set the cache timeout.

setChildEntries(List) - Method in class org.apache.maven.doxia.index.IndexEntry

Sets the child entriesor creates a new ArrayList if entries == null.

setSecondParsing(boolean) - Method in class org.apache.maven.doxia.parser.AbstractParser

Set secondParsing to true, if we need a second parsing.

setTitle(String) - Method in class org.apache.maven.doxia.index.IndexEntry

Sets the title.

SinkAdapter - Class in org.apache.maven.doxia.sink

Empty implementation of the Sink interface.

SinkAdapter() - Constructor for class org.apache.maven.doxia.sink.SinkAdapter

SiteModule - Interface in org.apache.maven.doxia.module.site

Provides definitions for a Doxia module.

SiteModuleManager - Interface in org.apache.maven.doxia.module.site.manager

Handles SiteModule lookups.

SiteModuleNotFoundException - Exception in org.apache.maven.doxia.module.site.manager

Encapsulate a Doxia exception that indicates that a SiteModule does not exist or could not be found.

SiteModuleNotFoundException(String) - Constructor for exception org.apache.maven.doxia.module.site.manager.SiteModuleNotFoundException

Construct a new SiteModuleNotFoundException with the specified detail message.

SiteModuleNotFoundException(Throwable) - Constructor for exception org.apache.maven.doxia.module.site.manager.SiteModuleNotFoundException

Constructs a new SiteModuleNotFoundException with the specified cause.

SiteModuleNotFoundException(String, Throwable) - Constructor for exception org.apache.maven.doxia.module.site.manager.SiteModuleNotFoundException

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

SLASH - Static variable in interface org.apache.maven.doxia.markup.Markup

slash character: '/'

SnippetMacro - Class in org.apache.maven.doxia.macro.snippet

A macro that prints out the content of a file or a URL.

SnippetMacro() - Constructor for class org.apache.maven.doxia.macro.snippet.SnippetMacro

SnippetReader - Class in org.apache.maven.doxia.macro.snippet

Utility class for reading snippets.

SnippetReader(URL) - Constructor for class org.apache.maven.doxia.macro.snippet.SnippetReader

Constructor.

SPACE - Static variable in interface org.apache.maven.doxia.markup.Markup

space character: ' '

STAR - Static variable in interface org.apache.maven.doxia.markup.Markup

star character: '*'

StructureSink - Class in org.apache.maven.doxia.sink

Utility methods for Sinks.

StructureSink() - Constructor for class org.apache.maven.doxia.sink.StructureSink

SwfMacro - Class in org.apache.maven.doxia.macro

Macro for embedding Flash (SWF) within Maven documentation.

SwfMacro() - Constructor for class org.apache.maven.doxia.macro.SwfMacro

T

table() - Method in class org.apache.maven.doxia.sink.SinkAdapter

table_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

tableCaption() - Method in class org.apache.maven.doxia.sink.SinkAdapter

tableCaption_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

tableCell() - Method in class org.apache.maven.doxia.sink.SinkAdapter

tableCell(String) - Method in class org.apache.maven.doxia.sink.SinkAdapter

tableCell_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

tableHeaderCell() - Method in class org.apache.maven.doxia.sink.SinkAdapter

tableHeaderCell(String) - Method in class org.apache.maven.doxia.sink.SinkAdapter

tableHeaderCell_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

tableRow() - Method in class org.apache.maven.doxia.sink.SinkAdapter

tableRow_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

tableRows(int[], boolean) - Method in class org.apache.maven.doxia.sink.SinkAdapter

tableRows_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

text(String) - Method in class org.apache.maven.doxia.index.IndexingSink

text(String) - Method in class org.apache.maven.doxia.sink.SinkAdapter

TextMarkup - Interface in org.apache.maven.doxia.markup

List of constants used by Text markup syntax.

title() - Method in class org.apache.maven.doxia.index.IndexingSink

title() - Method in class org.apache.maven.doxia.sink.SinkAdapter

title_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

TocMacro - Class in org.apache.maven.doxia.macro.toc

Macro to display a Table Of Content in a given Sink.

TocMacro() - Constructor for class org.apache.maven.doxia.macro.toc.TocMacro

toString() - Method in class org.apache.maven.doxia.index.IndexEntry

Returns a string representation of the object.

toString(int) - Method in class org.apache.maven.doxia.index.IndexEntry

Returns a string representation of all objects to the given depth.

TXT_TYPE - Static variable in interface org.apache.maven.doxia.parser.Parser

Text parser type

U

unget(String) - Method in class org.apache.maven.doxia.util.ByLineReaderSource

unget(String) - Method in interface org.apache.maven.doxia.util.ByLineSource

ungetLine() - Method in class org.apache.maven.doxia.util.ByLineReaderSource

ungetLine() - Method in interface org.apache.maven.doxia.util.ByLineSource

UNKNOWN_TYPE - Static variable in interface org.apache.maven.doxia.parser.Parser

Unknown parser type

V

verbatim(boolean) - Method in class org.apache.maven.doxia.sink.SinkAdapter

verbatim_() - Method in class org.apache.maven.doxia.sink.SinkAdapter

W

write(String) - Method in class org.apache.maven.doxia.sink.AbstractXmlSink

TODO DOXIA-59 Need to uniform writing

write(String) - Method in class org.apache.maven.doxia.util.LineBreaker

Writes the given text to the writer.

write(String, boolean) - Method in class org.apache.maven.doxia.util.LineBreaker

Writes the given text to the writer.

writeEndTag(HTML.Tag) - Method in class org.apache.maven.doxia.sink.AbstractXmlSink

Ends a Tag.

writeSimpleTag(HTML.Tag) - Method in class org.apache.maven.doxia.sink.AbstractXmlSink

Starts a simple Tag.

writeSimpleTag(HTML.Tag, MutableAttributeSet) - Method in class org.apache.maven.doxia.sink.AbstractXmlSink

Starts a simple Tag with attributes.

writeStartTag(HTML.Tag) - Method in class org.apache.maven.doxia.sink.AbstractXmlSink

Starts a Tag.

writeStartTag(HTML.Tag, MutableAttributeSet) - Method in class org.apache.maven.doxia.sink.AbstractXmlSink

Starts a Tag with attributes.

writeStartTag(HTML.Tag, MutableAttributeSet, boolean) - Method in class org.apache.maven.doxia.sink.AbstractXmlSink

Starts a Tag with attributes.

X

XML_TYPE - Static variable in interface org.apache.maven.doxia.parser.Parser

XML parser type

XmlMarkup - Interface in org.apache.maven.doxia.markup

List of constants used by Xml markup syntax.

A B C D E F G H I J L M N O P Q R S T U V W X