Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractDocumentRenderer - Class in org.apache.maven.doxia.docrenderer
-
Abstract
document
renderer. - AbstractDocumentRenderer() - Constructor for class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
- AbstractPdfRenderer - Class in org.apache.maven.doxia.docrenderer.pdf
-
Abstract pdf renderer, this doesn't depend on the framework.
- AbstractPdfRenderer() - Constructor for class org.apache.maven.doxia.docrenderer.pdf.AbstractPdfRenderer
C
- containsKey(Object) - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Indicates whether the specified key is in the context.
- copyDirectory(File, File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Copy content of a directory, excluding scm-specific files.
- copyResources(File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Copies the contents of the resource directory to an output folder.
D
- DocRenderer - Interface in org.apache.maven.doxia.docrenderer
-
Deprecated.
- DocumentRenderer - Interface in org.apache.maven.doxia.docrenderer
-
Base interface for rendering documents from a set of input files.
- DocumentRendererContext - Class in org.apache.maven.doxia.docrenderer
-
Context when processing Velocity files using a
HashMap
for data storage. - DocumentRendererContext() - Constructor for class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Default constructor.
- DocumentRendererException - Exception in org.apache.maven.doxia.docrenderer
-
A
document
renderer exception - DocumentRendererException(String) - Constructor for exception org.apache.maven.doxia.docrenderer.DocumentRendererException
-
Default constructor.
- DocumentRendererException(String, Throwable) - Constructor for exception org.apache.maven.doxia.docrenderer.DocumentRendererException
-
Other constructor.
- doxia - Variable in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
E
- endsWithIgnoreCase(String, String) - Static method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
- endsWithIgnoreCase(String, String[]) - Static method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
F
- FoPdfRenderer - Class in org.apache.maven.doxia.docrenderer.pdf.fo
-
PDF renderer that uses Doxia's FO module.
- FoPdfRenderer() - Constructor for class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
G
- generatePdf(File, File) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Generate a final pdf ouput file from an intermediate format file.
- generatePdf(File, File) - Method in interface org.apache.maven.doxia.docrenderer.pdf.PdfRenderer
-
Generate a final pdf ouput file from an intermediate format file.
- get(String) - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Gets the value corresponding to the provided key from the context.
- getBaseDir() - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Return the current base directory.
- getExtensions(ParserModule) - Static method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
- getFilesToProcess(File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Returns a Map of files to process.
- getFilesToProcess(Collection<String>) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Returns a Map of files to process.
- getInputEncoding() - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
- getKeys() - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Get all the keys for the values in the context
- getOutputExtension() - Method in interface org.apache.maven.doxia.docrenderer.DocRenderer
-
Deprecated.Get the output extension supported
- getOutputExtension() - Method in interface org.apache.maven.doxia.docrenderer.DocumentRenderer
-
Get the output extension associated with this DocumentRenderer.
- getOutputExtension() - Method in class org.apache.maven.doxia.docrenderer.pdf.AbstractPdfRenderer
-
Get the output extension associated with this DocumentRenderer.
- getOutputName(DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
O
- org.apache.maven.doxia.docrenderer - package org.apache.maven.doxia.docrenderer
- org.apache.maven.doxia.docrenderer.pdf - package org.apache.maven.doxia.docrenderer.pdf
- org.apache.maven.doxia.docrenderer.pdf.fo - package org.apache.maven.doxia.docrenderer.pdf.fo
P
- parse(String, String, Sink) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- parse(String, String, Sink, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Parse a source document into a sink.
- parserModuleManager - Variable in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
- PdfRenderer - Interface in org.apache.maven.doxia.docrenderer.pdf
-
PDF renderer interface.
- put(String, Object) - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Adds a name/value pair to the context.
R
- readDocumentModel(File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Read a document model from a file.
- readDocumentModel(File) - Method in interface org.apache.maven.doxia.docrenderer.DocumentRenderer
-
Read a document model from a file.
- remove(Object) - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
-
Removes the value associated with the specified key from the context.
- render(File, File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Render a document from the files found in baseDirectory.
- render(File, File) - Method in interface org.apache.maven.doxia.docrenderer.DocRenderer
-
Deprecated.Render all files from a site directory to an output directory
- render(File, File, File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Render a document from the files found in baseDirectory.
- render(File, File, File) - Method in interface org.apache.maven.doxia.docrenderer.DocRenderer
-
Deprecated.Render a document depending a context and a document descriptor
- render(File, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Render a document from the files found in a source directory, depending on a rendering context.
- render(File, File, DocumentModel) - Method in interface org.apache.maven.doxia.docrenderer.DocumentRenderer
-
Render a document from the files found in a source directory, depending on a rendering context.
- render(File, File, DocumentModel, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Render a document from the files found in a source directory, depending on a rendering context.
- render(Collection<String>, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Render a document from a set of files, depending on a rendering context.
- render(Collection<String>, File, DocumentModel) - Method in interface org.apache.maven.doxia.docrenderer.DocumentRenderer
-
Render a document from a set of files, depending on a rendering context.
- render(Map<String, ParserModule>, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- render(Map<String, ParserModule>, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.pdf.AbstractPdfRenderer
-
Render an aggregate document from the files found in a Map.
- render(Map<String, ParserModule>, File, DocumentModel) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Render an aggregate document from the files found in a Map.
- render(Map<String, ParserModule>, File, DocumentModel, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Render an aggregate document from the files found in a Map.
- render(Map<String, ParserModule>, File, DocumentModel, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Render an aggregate document from the files found in a Map.
- renderIndividual(Map<String, ParserModule>, File) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Deprecated.
- renderIndividual(Map<String, ParserModule>, File) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Render documents separately for each file found in a Map.
- renderIndividual(Map<String, ParserModule>, File, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Render documents separately for each file found in a Map.
- renderIndividual(Map<String, ParserModule>, File, DocumentRendererContext) - Method in class org.apache.maven.doxia.docrenderer.pdf.fo.FoPdfRenderer
-
Render documents separately for each file found in a Map.
- ROLE - Static variable in interface org.apache.maven.doxia.docrenderer.DocRenderer
-
Deprecated.Plexus lookup.
- ROLE - Static variable in interface org.apache.maven.doxia.docrenderer.DocumentRenderer
-
Plexus lookup role.
- ROLE - Static variable in interface org.apache.maven.doxia.docrenderer.pdf.PdfRenderer
-
Plexus lookup role.
S
- setBaseDir(String) - Method in class org.apache.maven.doxia.docrenderer.AbstractDocumentRenderer
-
Sets the current base directory.
- setInputEncoding(String) - Method in class org.apache.maven.doxia.docrenderer.DocumentRendererContext
All Classes and Interfaces|All Packages|Serialized Form
DocumentRenderer
instead.