com.fizzed.maven.versionizer

Class GenerateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.fizzed.maven.versionizer.GenerateMojo

All Implemented Interfaces:

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

@Mojo(name="generate",
      defaultPhase=GENERATE_SOURCES,
      threadSafe=true)
public class GenerateMojo
extends org.apache.maven.plugin.AbstractMojo

Utility for generating a Java source code file that will be compiled with a project to supply a Version class. An alternative to extracting the manifest inside a jar for getting a version of a dependency at runtime. Will generate the Java source file by default during the "generate sources" phase and will also attach the outputDirectory it uses to the project's source code.

Author:

joelauer

Field Summary

Fields

Modifier and Type	Field and Description
protected String	className Name of Version class to generate.
protected String	javaPackage Package name of Version class file.
protected File	outputDirectory Directory to output generated Java source file
protected org.apache.maven.project.MavenProject	project
protected String	versionCommit Commit of project for Version class (such as git hash, usually produced from another plugin).
protected String	versionName Name of build for Version class (artifactId is usually best).
protected String	versionTimestamp Timestamp of build for Version class.
protected Long	versionTimestampMillis Timestamp of build for Version class.
protected String	versionVendor Vendor of build for Version class (groupId is usually best).
protected String	versionVersion Version of build for Version class.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
GenerateMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()

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

Field Detail

outputDirectory

@Parameter(property="outputDirectory",
           alias="versionizer.outputDirectory",
           defaultValue="${project.build.directory}/generated-sources/versionizer",
           required=true)
protected File outputDirectory

Directory to output generated Java source file

Since:

1.0.0

javaPackage

@Parameter(property="javaPackage",
           alias="versionizer.javaPackage",
           defaultValue="")
protected String javaPackage

Package name of Version class file.

Since:

1.0.0

className

@Parameter(property="className",
           alias="versionizer.className",
           defaultValue="Version",
           required=true)
protected String className

Name of Version class to generate.

Since:

1.0.0

versionCommit

@Parameter(property="versionCommit",
           alias="versionizer.commit",
           defaultValue="unknown",
           required=false)
protected String versionCommit

Commit of project for Version class (such as git hash, usually produced from another plugin).

Since:

1.0.0

versionTimestampMillis

@Parameter(property="versionTimestampMillis",
           alias="versionizer.timestampMillis",
           defaultValue="",
           required=false)
protected Long versionTimestampMillis

Timestamp of build for Version class.

Since:

1.0.0

versionTimestamp

@Parameter(property="versionTimestamp",
           alias="versionizer.timestamp",
           defaultValue="",
           required=false)
protected String versionTimestamp

Timestamp of build for Version class.

Since:

1.0.0

versionVersion

@Parameter(property="versionVersion",
           alias="versionizer.version",
           defaultValue="${project.version}",
           required=true)
protected String versionVersion

Version of build for Version class.

Since:

1.0.0

versionName

@Parameter(property="versionName",
           alias="versionizer.name",
           defaultValue="${project.artifactId}",
           required=true)
protected String versionName

Name of build for Version class (artifactId is usually best).

Since:

1.0.0

versionVendor

@Parameter(property="versionVendor",
           alias="versionizer.vendor",
           defaultValue="${project.groupId}",
           required=true)
protected String versionVendor

Vendor of build for Version class (groupId is usually best).

Since:

1.0.0

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

Constructor Detail

GenerateMojo

public GenerateMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException