|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.jboss.maven.plugins.jdocbook.AbstractDocBookMojo
public abstract class AbstractDocBookMojo
Basic support for the various DocBook mojos in this packaging plugin. Mainly, we are defining common configuration attributes of the packaging.
Nested Class Summary | |
---|---|
protected static interface |
AbstractDocBookMojo.ArtifactProcessor
|
protected static interface |
AbstractDocBookMojo.I18nSource
|
protected class |
AbstractDocBookMojo.MasterTranslationDescriptor
|
protected static interface |
AbstractDocBookMojo.PublishingSource
|
protected class |
AbstractDocBookMojo.TranslationDescriptor
|
Field Summary | |
---|---|
protected org.codehaus.plexus.archiver.manager.ArchiverManager |
archiverManager
INTERNAL : used to get reference to environemtn Archiver/UnArchiver. |
protected boolean |
attach
Whether or not to perform the attching of the format outputs as classified attachments. |
protected org.apache.maven.model.Resource |
cssResource
A Resource describing project-local css. |
protected java.io.File |
fontsDirectory
The directory containing local fonts |
protected Format[] |
formats
The formats in which to perform rendering. |
protected org.apache.maven.model.Resource |
imageResource
A Resource describing project-local images. |
protected java.lang.String |
masterTranslation
The locale of the master translation. |
protected Options |
options
Configurable options |
static java.lang.String |
PLUGIN_NAME
|
protected java.util.List |
pluginArtifacts
INTERNAL : The artifacts associated to the dependencies defined as part of our configuration within the project to which we are being attached. |
protected java.io.File |
potDirectory
The directory for POT translations files. |
protected org.apache.maven.project.MavenProject |
project
INTERNAL : The project being built |
protected java.util.Set |
projectArtifacts
INTERNAL : The artifacts associated with the dependencies defined as part of the project to which we are being attached. |
protected org.apache.maven.project.MavenProjectHelper |
projectHelper
INTERNAL : used during packaging to attach produced artifacts |
protected java.io.File |
publishDirectory
The directory where the output will be written. |
protected java.lang.String |
relativeMasterTranslationPath
The path (relative to the sourceDirectory) to the directory containing the master sources. |
protected org.apache.maven.execution.MavenSession |
session
INTERNAL : The representation of the maven execution. |
protected java.io.File |
sourceDirectory
The directory where the sources are located. |
protected java.lang.String |
sourceDocumentName
The name of the document (relative to sourceDirectory) which is the document to be rendered. |
protected java.io.File |
stagingDirectory
The directory where we can perform some staging staging occurs. |
protected java.io.File |
translationBaseDirectory
The directory which contains the translations. |
protected java.lang.String[] |
translations
The locales of all non-master translations. |
protected java.io.File |
workDirectory
A directory used for general transient work. |
Fields inherited from interface org.apache.maven.plugin.Mojo |
---|
ROLE |
Constructor Summary | |
---|---|
AbstractDocBookMojo()
|
Method Summary | |
---|---|
protected void |
doExecute()
|
void |
execute()
|
protected java.util.List<AbstractDocBookMojo.I18nSource> |
getI18nSources()
|
protected AbstractDocBookMojo.MasterTranslationDescriptor |
getMasterTranslationDescriptor()
|
protected java.util.List<AbstractDocBookMojo.PublishingSource> |
getPublishingSources()
|
protected java.lang.String |
getRequestedFormat()
|
protected java.util.Locale |
getRequestedLocale()
|
protected java.util.Locale |
parseLocale(java.lang.String locale)
|
protected void |
process(FormatPlan[] formatPlans)
The override method to perform the actual processing of the mojo. |
protected void |
processArtifacts(AbstractDocBookMojo.ArtifactProcessor processor)
|
protected void |
processPluginArtifacts(AbstractDocBookMojo.ArtifactProcessor processor)
|
protected void |
processProjectArtifacts(AbstractDocBookMojo.ArtifactProcessor processor)
|
protected java.lang.String |
stringify(java.util.Locale locale)
|
Methods inherited from class org.apache.maven.plugin.AbstractMojo |
---|
getLog, getPluginContext, setLog, setPluginContext |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PLUGIN_NAME
protected org.apache.maven.project.MavenProject project
protected org.apache.maven.execution.MavenSession session
protected java.util.Set projectArtifacts
protected java.util.List pluginArtifacts
protected org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager
protected org.apache.maven.project.MavenProjectHelper projectHelper
protected java.lang.String sourceDocumentName
protected java.io.File sourceDirectory
protected org.apache.maven.model.Resource imageResource
Resource
describing project-local images.
protected org.apache.maven.model.Resource cssResource
Resource
describing project-local css.
protected java.io.File fontsDirectory
protected java.io.File publishDirectory
protected java.io.File stagingDirectory
protected java.io.File workDirectory
protected Format[] formats
protected boolean attach
protected Options options
protected java.lang.String masterTranslation
protected java.lang.String relativeMasterTranslationPath
protected java.io.File potDirectory
protected java.lang.String[] translations
protected java.io.File translationBaseDirectory
Constructor Detail |
---|
public AbstractDocBookMojo()
Method Detail |
---|
protected void process(FormatPlan[] formatPlans) throws JDocBookProcessException
formatPlans
- The format plans
RenderingException
- Indicates problem performing rendering
XSLTException
- Indicates problem building or executing XSLT transformer
JDocBookProcessException
protected void doExecute() throws JDocBookProcessException
JDocBookProcessException
public final void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
protected java.lang.String getRequestedFormat()
protected java.util.Locale getRequestedLocale()
protected AbstractDocBookMojo.MasterTranslationDescriptor getMasterTranslationDescriptor()
protected java.util.List<AbstractDocBookMojo.PublishingSource> getPublishingSources()
protected java.util.List<AbstractDocBookMojo.I18nSource> getI18nSources()
protected void processArtifacts(AbstractDocBookMojo.ArtifactProcessor processor)
protected void processProjectArtifacts(AbstractDocBookMojo.ArtifactProcessor processor)
protected void processPluginArtifacts(AbstractDocBookMojo.ArtifactProcessor processor)
protected java.util.Locale parseLocale(java.lang.String locale)
protected java.lang.String stringify(java.util.Locale locale)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |