Package org.apache.maven.plugins.pdf

Class DocumentDescriptorReader

java.lang.Object

org.apache.maven.plugins.pdf.DocumentDescriptorReader

public class DocumentDescriptorReader
extends Object

Read and filter a DocumentModel from a document descriptor file.

Author:

ltheussl

Constructor Summary

Constructors

Constructor	Description
DocumentDescriptorReader()	Constructor.
DocumentDescriptorReader(org.apache.maven.project.MavenProject project)	Constructor.
DocumentDescriptorReader(org.apache.maven.project.MavenProject project, org.apache.maven.plugin.logging.Log log, Locale locale)	Constructor.

Method Summary

Modifier and Type	Method	Description
org.apache.maven.doxia.document.DocumentModel	readAndFilterDocumentDescriptor(File docDescriptor)	Read and filter the docDescriptor file.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentDescriptorReader

public DocumentDescriptorReader()

Constructor.

DocumentDescriptorReader

public DocumentDescriptorReader(org.apache.maven.project.MavenProject project)

Constructor.

Parameters:

project - may be null.

DocumentDescriptorReader

public DocumentDescriptorReader(org.apache.maven.project.MavenProject project,
                                org.apache.maven.plugin.logging.Log log,
                                Locale locale)

Constructor.

Parameters:

project - may be null.

log - may be null.

Method Detail

readAndFilterDocumentDescriptor

public org.apache.maven.doxia.document.DocumentModel readAndFilterDocumentDescriptor(File docDescriptor)
                                                                              throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
                                                                                     IOException

Read and filter the docDescriptor file.

Parameters:

docDescriptor - not null, corresponding to non-localized descriptor file.

Returns:

a DocumentModel instance.

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException - if an error occurs during parsing.

IOException - if an error occurs during reading.