Package com.github.koraktor.mavanagaiata.mojo

Class InfoClassMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

com.github.koraktor.mavanagaiata.mojo.InfoClassMojo

All Implemented Interfaces:

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

@Mojo(name="info-class",
      defaultPhase=GENERATE_SOURCES,
      threadSafe=true)
public class InfoClassMojo
extends AbstractGitMojo

This goal generates the source code for a Java class with Git information like commit ID and tag name.

Since:

0.5.0

Author:

Sebastian Staudt

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	InfoClassMojo.ValueSourceFilter

Field Summary

Fields

Modifier and Type	Field	Description
private static String	BUILTIN_TEMPLATE_PATH
(package private) String	className	The name of the class to generate
(package private) String	encoding	The encoding of the generated source file
(package private) org.apache.maven.shared.filtering.MavenFileFilter	fileFilter
(package private) File	outputDirectory	The directory to write the source code to
(package private) String	packageName	The name of the package in which the class will be generated
private File	templateFile	The path to an alternative template for the info class

Fields inherited from class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

baseDir, dateFormat, dirtyFlag, dirtyIgnoreUntracked, failGracefully, gitDir, head, project, propertyPrefixes, skip, skipNoGit

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

ROLE

Constructor Summary

Constructors

Constructor	Description
InfoClassMojo()

Method Summary

Modifier and Type	Method	Description
private File	copyTemporaryTemplate()
(package private) InputStream	getTemplateSource()	Returns an input stream for the template source file for the info class
(package private) org.codehaus.plexus.interpolation.MapBasedValueSource	getValueSource(GitRepository repository)
void	run(GitRepository repository)	Generates a info class filled providing information of the Git repository
private void	writeSourceFile(GitRepository repository, File sourceFile)

Methods inherited from class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

addProperty, execute, init, initRepository, prepareParameters

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

BUILTIN_TEMPLATE_PATH

private static final String BUILTIN_TEMPLATE_PATH

See Also:

Constant Field Values

className

@Parameter(property="mavanagaiata.info-class.className",
           defaultValue="GitInfo")
String className

The name of the class to generate

encoding

@Parameter(property="mavanagaiata.info-class.encoding",
           defaultValue="${project.build.sourceEncoding}")
String encoding

The encoding of the generated source file

fileFilter

@Component
org.apache.maven.shared.filtering.MavenFileFilter fileFilter

packageName

@Parameter(property="mavanagaiata.info-class.packageName",
           defaultValue="${project.groupId}.${project.artifactId}")
String packageName

The name of the package in which the class will be generated

outputDirectory

@Parameter(property="mavanagaiata.info-class.outputDirectory",
           defaultValue="${project.build.directory}/generated-sources/mavanagaiata")
File outputDirectory

The directory to write the source code to

This directory is automatically added to the source roots used to compile the project.

templateFile

@Parameter(property="mavanagaiata.info-class.templatePath")
private File templateFile

The path to an alternative template for the info class

Constructor Detail

InfoClassMojo

public InfoClassMojo()

Method Detail

getTemplateSource

InputStream getTemplateSource()
                       throws FileNotFoundException

Returns an input stream for the template source file for the info class

This may either be the builtin template or an arbitrary source file set via templatePath.

Returns:

An input stream for the template source file

Throws:

FileNotFoundException - if the template source cannot be found

run

public void run(GitRepository repository)
         throws MavanagaiataMojoException

Generates a info class filled providing information of the Git repository

Specified by:

run in class AbstractGitMojo

Parameters:

repository - The repository instance to use

Throws:

MavanagaiataMojoException - if the info class cannot be generated

copyTemporaryTemplate

private File copyTemporaryTemplate()
                            throws IOException,
                                   MavanagaiataMojoException

Throws:

IOException

MavanagaiataMojoException

getValueSource

org.codehaus.plexus.interpolation.MapBasedValueSource getValueSource(GitRepository repository)
                                                              throws GitRepositoryException

Throws:

GitRepositoryException

writeSourceFile

private void writeSourceFile(GitRepository repository,
                             File sourceFile)
                      throws GitRepositoryException,
                             MavanagaiataMojoException,
                             org.apache.maven.shared.filtering.MavenFilteringException

Throws:

GitRepositoryException

MavanagaiataMojoException

org.apache.maven.shared.filtering.MavenFilteringException