@Mojo(name="resource-bundle", defaultPhase=PACKAGE, requiresDependencyResolution=COMPILE, threadSafe=true) public class ResourcesBundleMojo extends AbstractJavadocMojo
AbstractJavadocMojo.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 the includeDependencySources
option, to generate
javadocs that are somewhat consistent with those generated in the original project itself.Modifier and Type | Field and 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.
|
ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, DEFAULT_JAVA_API_LINKS, failOnError, failOnWarnings, FILES_FILE_NAME, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, OPTIONS_FILE_NAME, outputDirectory, PACKAGES_FILE_NAME, project, session, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions
Constructor and Description |
---|
ResourcesBundleMojo() |
Modifier and Type | Method and Description |
---|---|
void |
doExecute()
Assemble a new
JavadocOptions instance that
contains the configuration options in this
mojo, which are a subset of those provided in derivatives of the AbstractJavadocMojo
class (most of the javadoc mojos, in other words). |
buildJavadocOptions, canGenerateReport, collect, configureDependencySourceResolution, execute, executeReport, failOnError, getAttachmentClassifier, getDependencyScopeFilter, getDependencySourcePaths, getDoclint, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getToolchain, getWindowtitle, isAggregator, isTest, isValidJavadocLink, logError, resolveDependency, verifyRemovedParameter
public static final java.lang.String BUNDLE_OPTIONS_PATH
public static final java.lang.String RESOURCES_DIR_PATH
@Parameter(defaultValue="${project.build.finalName}", readonly=true) private java.lang.String finalName
AbstractJavadocMojo.getAttachmentClassifier()
to produce the name for this bundle
jar.@Component private org.apache.maven.project.MavenProjectHelper projectHelper
@Component private org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager
public void doExecute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
JavadocOptions
instance that
contains the configuration options in this
mojo, which are a subset of those provided in derivatives of the AbstractJavadocMojo
class (most of the javadoc mojos, in other words). Then, bundle the contents of the
javadocDirectory
along with the assembled JavadocOptions instance (serialized to
META-INF/maven/javadoc-options.xml) into a project attachment for installation/deployment.
doExecute
in class AbstractJavadocMojo
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
Mojo.execute()