Package scala_maven
Class ScalaDocJarMojo
java.lang.Object
org.apache.maven.plugin.AbstractMojo
scala_maven.ScalaMojoSupport
scala_maven.ScalaSourceMojoSupport
scala_maven.ScalaDocMojo
scala_maven.ScalaDocJarMojo
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
,org.apache.maven.reporting.MavenReport
@Mojo(name="doc-jar",
defaultPhase=PACKAGE,
requiresDependencyResolution=COMPILE)
public class ScalaDocJarMojo
extends ScalaDocMojo
Creates a jar of the non-aggregated scaladoc and attaches it
to the project for distribution.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.apache.maven.archiver.MavenArchiveConfiguration
The archive configuration to use.private boolean
Specifies whether to attach the generated artifact to the project helper.private String
Specifies the classifier of the generated artifact.private static final String[]
private static final String[]
private File
Path to the default MANIFEST file to use.protected boolean
Specifies if the build will fail if there are errors during javadoc execution or not.private String
Specifies the filename that will be used for the generated jar file.private org.codehaus.plexus.archiver.jar.JarArchiver
The Jar archiver.private String
Specifies the directory where the generated jar file will be put.private org.apache.maven.project.MavenProjectHelper
Used for attaching the artifact in the project.private boolean
Specifies whether to skip generating scaladoc.private boolean
Set this totrue
to enable the use of thedefaultManifestFile
.Fields inherited from class scala_maven.ScalaDocMojo
aggregateDirectOnly, bottom, charset, doctitle, footer, forceAggregate, header, linksource, nocomment, outputDirectory, reportOutputDirectory, scaladocClassName, sourceDir, stylesheetfile, top, vscaladocVersion, windowtitle
Fields inherited from class scala_maven.ScalaSourceMojoSupport
excludes, includes, sendJavaToScalac
Fields inherited from class scala_maven.ScalaMojoSupport
addJavacArgs, addScalacArgs, args, checkMultipleScalaVersions, compilerPlugins, dependencies, displayCmd, encoding, factory, failOnMultipleScalaVersions, forceUseArgFile, fork, JAR, javacArgs, javacGenerateDebugSymbols, jvmArgs, localRepo, mavenProjectBuilder, POM, project, reactorProjects, remoteRepos, resolver, SCALA_COMPILER_ARTIFACTID, SCALA_LIBRARY_ARTIFACTID, scalaClassName, session, source, target, toolchainManager, useCanonicalPath
Fields inherited from interface org.apache.maven.reporting.MavenReport
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
protected void
failOnError
(String prefix, Exception e) private File
generateArchive
(File javadocFiles, String jarFileName) Method that creates the jar fileprotected String
Methods inherited from class scala_maven.ScalaDocMojo
aggregate, canGenerateReport, generate, getCategoryName, getDescription, getName, getOutputName, getReportOutputDirectory, getScalaCommand, getSourceDirectories, isExternalReport, setReportOutputDirectory, tryAggregateUpper
Methods inherited from class scala_maven.ScalaSourceMojoSupport
findSourceWithFilters, findSourceWithFilters, initFilters, normalize
Methods inherited from class scala_maven.ScalaMojoSupport
addCompilerPluginOptions, addCompilerToClasspath, addLibraryToClasspath, addToClasspath, addToClasspath, addToClasspath, addToClasspath, checkScalaVersion, execute, findScalaVersion, findVersionFromDependencies, findVersionFromPluginArtifacts, getAllDependencies, getArtifactJar, getArtifactJar, getCompilerDependencies, getCompilerJar, getCompilerPluginOptions, getDependencies, getEmptyScalaCommand, getEmptyScalaCommand, getJavacOptions, getLibraryJar, getPluginArtifactJar, getPluginArtifactJar, getScalaCommand, getScalaOptions, getScalaOrganization, isJavaSupportedByCompiler, resolveArtifactDependencies, resolveDependencyArtifacts, resolveDependencyArtifacts, scalaCompilerArtifact
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
Methods inherited from interface org.apache.maven.reporting.MavenReport
getOutputPath
-
Field Details
-
DEFAULT_INCLUDES
-
DEFAULT_EXCLUDES
-
jarArchiver
@Component(role=org.codehaus.plexus.archiver.Archiver.class, hint="jar") private org.codehaus.plexus.archiver.jar.JarArchiver jarArchiverThe Jar archiver. -
projectHelper
@Component private org.apache.maven.project.MavenProjectHelper projectHelperUsed for attaching the artifact in the project. -
finalName
Specifies the filename that will be used for the generated jar file. Please note that-javadoc
or-test-javadoc
will be appended to the file name. -
attach
@Parameter(property="attach", defaultValue="true") private boolean attachSpecifies whether to attach the generated artifact to the project helper. -
classifier
Specifies the classifier of the generated artifact. -
skip
@Parameter(property="skip", defaultValue="false") private boolean skipSpecifies whether to skip generating scaladoc. -
jarOutputDirectory
Specifies the directory where the generated jar file will be put. -
archive
@Parameter private org.apache.maven.archiver.MavenArchiveConfiguration archiveThe archive configuration to use. See Maven Archiver Reference. -
defaultManifestFile
@Parameter(defaultValue="${project.build.outputDirectory}/META-INF/MANIFEST.MF", required=true, readonly=true) private File defaultManifestFilePath to the default MANIFEST file to use. It will be used ifuseDefaultManifestFile
is set totrue
. -
useDefaultManifestFile
@Parameter(defaultValue="false") private boolean useDefaultManifestFileSet this totrue
to enable the use of thedefaultManifestFile
. -
failOnError
@Parameter(property="maven.javadoc.failOnError", defaultValue="true") protected boolean failOnErrorSpecifies if the build will fail if there are errors during javadoc execution or not.- Since:
- 2.5
-
-
Constructor Details
-
ScalaDocJarMojo
public ScalaDocJarMojo()
-
-
Method Details
-
doExecute
- Overrides:
doExecute
in classScalaDocMojo
- Throws:
Exception
-
generateArchive
private File generateArchive(File javadocFiles, String jarFileName) throws org.codehaus.plexus.archiver.ArchiverException, IOException Method that creates the jar file- Parameters:
javadocFiles
- the directory where the generated jar file will be putjarFileName
- the filename of the generated jar file- Returns:
- a File object that contains the generated jar file
- Throws:
org.codehaus.plexus.archiver.ArchiverException
IOException
-
getClassifier
-
failOnError
protected void failOnError(String prefix, Exception e) throws org.apache.maven.plugin.MojoExecutionException - Throws:
org.apache.maven.plugin.MojoExecutionException
-