Package org.apache.maven.plugins.javadoc
Class ResourcesBundleMojo
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.apache.maven.plugins.javadoc.AbstractJavadocMojo
-
- org.apache.maven.plugins.javadoc.ResourcesBundleMojo
-
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
- Direct Known Subclasses:
TestResourcesBundleMojo
@Mojo(name="resource-bundle", defaultPhase=PACKAGE, requiresDependencyResolution=COMPILE, threadSafe=true) public class ResourcesBundleMojo extends AbstractJavadocMojo
BundleAbstractJavadocMojo.javadocDirectory
, along with javadoc configuration options such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by theincludeDependencySources
option, to generate javadocs that are somewhat consistent with those generated in the original project itself.- Since:
- 2.7
-
-
Field Summary
Fields Modifier and Type Field Description private org.codehaus.plexus.archiver.manager.ArchiverManager
archiverManager
Archiver manager, used to manage jar builder.static java.lang.String
BUNDLE_OPTIONS_PATH
Bundle options path.private java.lang.String
finalName
Base name of artifacts produced by this project.private org.apache.maven.project.MavenProjectHelper
projectHelper
Helper component to provide an easy mechanism for attaching an artifact to the project for installation/deployment.static java.lang.String
RESOURCES_DIR_PATH
Resources directory path.-
Fields inherited from class org.apache.maven.plugins.javadoc.AbstractJavadocMojo
ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, failOnError, failOnWarnings, FILES_FILE_NAME, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, locationManager, OPTIONS_FILE_NAME, outputDirectory, PACKAGES_FILE_NAME, project, session, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions
-
-
Constructor Summary
Constructors Constructor Description ResourcesBundleMojo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
doExecute()
Assemble a newJavadocOptions
instance that contains the configuration options in this mojo, which are a subset of those provided in derivatives of theAbstractJavadocMojo
class (most of the javadoc mojos, in other words).-
Methods inherited from class org.apache.maven.plugins.javadoc.AbstractJavadocMojo
buildJavadocOptions, canGenerateReport, collect, configureDependencySourceResolution, execute, executeReport, failOnError, getArtifactFile, getAttachmentClassifier, getDefaultJavadocApiLink, getDependencyScopeFilter, getDependencySourcePaths, getDoclint, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getToolchain, getWindowtitle, isAggregator, isSkippedJavadoc, isSkippedModule, isTest, isValidJavadocLink, logError, resolveDependency, verifyRemovedParameter
-
-
-
-
Field Detail
-
BUNDLE_OPTIONS_PATH
public static final java.lang.String BUNDLE_OPTIONS_PATH
Bundle options path.- See Also:
- Constant Field Values
-
RESOURCES_DIR_PATH
public static final java.lang.String RESOURCES_DIR_PATH
Resources directory path.- See Also:
- Constant Field Values
-
finalName
@Parameter(defaultValue="${project.build.finalName}", readonly=true) private java.lang.String finalName
Base name of artifacts produced by this project. This will be combined withAbstractJavadocMojo.getAttachmentClassifier()
to produce the name for this bundle jar.
-
projectHelper
@Component private org.apache.maven.project.MavenProjectHelper projectHelper
Helper component to provide an easy mechanism for attaching an artifact to the project for installation/deployment.
-
archiverManager
@Component private org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager
Archiver manager, used to manage jar builder.
-
-
Method Detail
-
doExecute
public void doExecute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
Assemble a newJavadocOptions
instance that contains the configuration options in this mojo, which are a subset of those provided in derivatives of theAbstractJavadocMojo
class (most of the javadoc mojos, in other words). Then, bundle the contents of thejavadocDirectory
along with the assembled JavadocOptions instance (serialized to META-INF/maven/javadoc-options.xml) into a project attachment for installation/deployment.- Specified by:
doExecute
in classAbstractJavadocMojo
- Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
- See Also:
Mojo.execute()
-
-