Package org.apache.maven.plugins.pdf

Klasse 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.

Autor:

ltheussl

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
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.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
org.apache.maven.doxia.document.DocumentModel	readAndFilterDocumentDescriptor(File docDescriptor)	Read and filter the docDescriptor file.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

DocumentDescriptorReader

public DocumentDescriptorReader()

Constructor.

DocumentDescriptorReader

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

Constructor.

Parameter:

project - may be null.

DocumentDescriptorReader

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

Constructor.

Parameter:

project - may be null.

log - may be null.

Methodendetails

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.

Parameter:

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

Gibt zurück:

a DocumentModel instance.

Löst aus:

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

IOException - if an error occurs during reading.