public abstract class AbstractDocBookMojo
extends org.apache.maven.plugin.AbstractMojo
Modifier and Type | Class and Description |
---|---|
protected static interface |
AbstractDocBookMojo.ArtifactProcessor |
protected static interface |
AbstractDocBookMojo.I18nSource |
protected class |
AbstractDocBookMojo.MasterTranslationDescriptor |
protected static interface |
AbstractDocBookMojo.PublishingSource |
protected class |
AbstractDocBookMojo.TranslationDescriptor |
Modifier and Type | Field and Description |
---|---|
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 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 String |
masterTranslation
The locale of the master translation.
|
protected Options |
options
Configurable options
|
static String |
PLUGIN_NAME |
protected 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 File |
potDirectory
The directory for POT translations files.
|
protected org.apache.maven.project.MavenProject |
project
INTERNAL : The project being built
|
protected 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 File |
publishDirectory
The directory where the output will be written.
|
protected 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 File |
sourceDirectory
The directory where the sources are located.
|
protected String |
sourceDocumentName
The name of the document (relative to sourceDirectory) which is the
document to be rendered.
|
protected File |
stagingDirectory
The directory where we can perform some staging staging occurs.
|
protected File |
translationBaseDirectory
The directory which contains the translations.
|
protected String[] |
translations
The locales of all non-master translations.
|
protected File |
workDirectory
A directory used for general transient work.
|
Constructor and Description |
---|
AbstractDocBookMojo() |
Modifier and Type | Method and Description |
---|---|
protected void |
doExecute() |
void |
execute() |
protected List<AbstractDocBookMojo.I18nSource> |
getI18nSources() |
protected AbstractDocBookMojo.MasterTranslationDescriptor |
getMasterTranslationDescriptor() |
protected List<AbstractDocBookMojo.PublishingSource> |
getPublishingSources() |
protected String |
getRequestedFormat() |
protected Locale |
getRequestedLocale() |
protected Locale |
parseLocale(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 String |
stringify(Locale locale) |
public static final String PLUGIN_NAME
protected org.apache.maven.project.MavenProject project
protected org.apache.maven.execution.MavenSession session
protected Set projectArtifacts
protected List pluginArtifacts
protected org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager
protected org.apache.maven.project.MavenProjectHelper projectHelper
protected String sourceDocumentName
protected 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 File fontsDirectory
protected File publishDirectory
protected File stagingDirectory
protected File workDirectory
protected Format[] formats
protected boolean attach
protected Options options
protected String masterTranslation
protected String relativeMasterTranslationPath
protected File potDirectory
protected String[] translations
protected File translationBaseDirectory
protected void process(FormatPlan[] formatPlans) throws JDocBookProcessException
formatPlans
- The format plansRenderingException
- Indicates problem performing renderingXSLTException
- Indicates problem building or executing XSLT transformerJDocBookProcessException
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 String getRequestedFormat()
protected Locale getRequestedLocale()
protected AbstractDocBookMojo.MasterTranslationDescriptor getMasterTranslationDescriptor()
protected List<AbstractDocBookMojo.PublishingSource> getPublishingSources()
protected List<AbstractDocBookMojo.I18nSource> getI18nSources()
protected void processArtifacts(AbstractDocBookMojo.ArtifactProcessor processor)
protected void processProjectArtifacts(AbstractDocBookMojo.ArtifactProcessor processor)
protected void processPluginArtifacts(AbstractDocBookMojo.ArtifactProcessor processor)
Copyright © 2007-2013 JBoss, a division of Red Hat, Inc. All Rights Reserved.