net.sf.jfxdplugin
Class JavafxdocJar

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      net.sf.jfxdplugin.AbstractJavafxdocMojo
          net.sf.jfxdplugin.JavafxdocJar

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class JavafxdocJar
extends AbstractJavafxdocMojo

Bundles the Javafxdoc documentation for the JavaFX code in a NON aggregator project into a jar using the standard Javafxdoc tool.

Based on the Maven Javadoc Plugin version 2.6.

Since:

1.0

Version:

$Revision: 63 $ $Date: 2010-04-07 21:07:01 -0400 (Wed, 07 Apr 2010) $

Author:

Nathan Erwin, Vincent Siveton

See Also:

http://maven.apache.org/plugins/maven-javadoc-plugin

Field Summary

Fields inherited from class net.sf.jfxdplugin.AbstractJavafxdocMojo

DEBUG_JAVAFXDOC_SCRIPT_NAME, DEFAULT_JAVA_API_LINKS, DEFAULT_JAVAFX_VERSION, FILES_FILE_NAME, OPTIONS_FILE_NAME, SINCE_JAVAFXDOC_1_3

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

JavafxdocJar()

Method Summary

void	execute() Entry point for the jar goal.
org.apache.maven.archiver.MavenArchiveConfiguration	getArchive() Returns the Maven archive configuration.
File	getDefaultManifestFile() Returns the default jar manifest file.
String	getFinalName() Returns the final name for the generated jar file.
org.codehaus.plexus.archiver.jar.JarArchiver	getJarArchiver() Returns the jar archiver for the plugin.
String	getJarOutputDirectory() Returns the output directory for the generated jar file.
boolean	isUseDefaultManifestFile() Returns whether the default manifest file is used.
void	setArchive(org.apache.maven.archiver.MavenArchiveConfiguration archive) Sets the Maven archive configuration.
void	setDefaultManifestFile(File defaultManifestFile) Sets the default jar manifest file.
void	setFinalName(String finalName) Sets the final name for the generated jar file.
void	setJarArchiver(org.codehaus.plexus.archiver.jar.JarArchiver jarArchiver) Sets the jar archiver for the plugin.
void	setJarOutputDirectory(String jarOutputDirectory) Sets the output directory for the generated jar file.
void	setUseDefaultManifestFile(boolean useDefaultManifestFile) Sets whether the default manifest file is used.

Methods inherited from class net.sf.jfxdplugin.AbstractJavafxdocMojo

canGenerateReport, executeReport, formatMessage, getAdditionalJOptions, getAdditionalXslOptions, getBootclasspath, getBundle, getDoclet, getDocletPath, getEncoding, getExcludePackageNames, getExtdirs, getExtracss, getExtrajs, getFiles, getInputFiles, getJavafxdocExecutable, getJavafxdocVersion, getLocale, getLocaleObject, getMastercss, getOutputDirectory, getOutputFile, getProfile, getProject, getProjectArtifacts, getSession, getShow, getSource, getSourcePath, getSourcePaths, getSubpackages, getToolchainManager, getXsltfile, isBreakiterator, isDebug, isFailOnError, isNohtml, isQuiet, isVerbose, setAdditionalJOptions, setAdditionalXslOptions, setBootclasspath, setBreakiterator, setDebug, setDoclet, setDocletPath, setEncoding, setExcludePackageNames, setExtdirs, setExtracss, setExtrajs, setFailOnError, setInputFiles, setJavafxdocExecutable, setLocale, setMastercss, setNohtml, setOutputDirectory, setOutputFile, setProfile, setProject, setQuiet, setShow, setSource, setSourcePath, setSubpackages, setToolchainManager, setVerbose, setXsltfile

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

Constructor Detail

JavafxdocJar

public JavafxdocJar()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Entry point for the jar goal.

Throws:

org.apache.maven.plugin.MojoExecutionException - thrown if and exception occurred during the execution of the plugin

org.apache.maven.plugin.MojoFailureException - not thrown

getFinalName

public String getFinalName()

Returns the final name for the generated jar file.

Returns:

the jar file name

See Also:

finalName

setFinalName

public void setFinalName(String finalName)

Sets the final name for the generated jar file.

Parameters:

finalName - the jar file name

See Also:

finalName

getJarArchiver

public org.codehaus.plexus.archiver.jar.JarArchiver getJarArchiver()

Returns the jar archiver for the plugin.

Returns:

the jar archiver

See Also:

jarArchiver

setJarArchiver

public void setJarArchiver(org.codehaus.plexus.archiver.jar.JarArchiver jarArchiver)

Sets the jar archiver for the plugin.

Parameters:

jarArchiver - the jar archiver

See Also:

jarArchiver

getJarOutputDirectory

public String getJarOutputDirectory()

Returns the output directory for the generated jar file.

Returns:

the jar output directory

See Also:

jarOutputDirectory

setJarOutputDirectory

public void setJarOutputDirectory(String jarOutputDirectory)

Sets the output directory for the generated jar file.

Parameters:

jarOutputDirectory - the jar output directory

See Also:

jarOutputDirectory

getArchive

public org.apache.maven.archiver.MavenArchiveConfiguration getArchive()

Returns the Maven archive configuration.

Returns:

the Maven archive configuration

See Also:

archive

setArchive

public void setArchive(org.apache.maven.archiver.MavenArchiveConfiguration archive)

Sets the Maven archive configuration.

Parameters:

archive - the Maven archive configuration

See Also:

archive

getDefaultManifestFile

public File getDefaultManifestFile()

Returns the default jar manifest file.

Returns:

the default manifest file

See Also:

defaultManifestFile

setDefaultManifestFile

public void setDefaultManifestFile(File defaultManifestFile)

Sets the default jar manifest file.

Parameters:

defaultManifestFile - the default manifest file

See Also:

defaultManifestFile

isUseDefaultManifestFile

public boolean isUseDefaultManifestFile()

Returns whether the default manifest file is used.

Returns:

true if used, false if not

See Also:

useDefaultManifestFile

setUseDefaultManifestFile

public void setUseDefaultManifestFile(boolean useDefaultManifestFile)

Sets whether the default manifest file is used.

Parameters:

useDefaultManifestFile - true is used, false if not

See Also:

useDefaultManifestFile