Package com.github.koraktor.mavanagaiata.mojo

Klasse InfoClassMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

com.github.koraktor.mavanagaiata.mojo.InfoClassMojo

Alle implementierten Schnittstellen:

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.

Seit:

0.5.0

Autor:

Sebastian Staudt

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
private class	InfoClassMojo.ValueSourceFilter

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
private static final String	BUILTIN_TEMPLATE_PATH
(Package privat) String	className	The name of the class to generate
(Package privat) String	encoding	The encoding of the generated source file
(Package privat) org.apache.maven.shared.filtering.MavenFileFilter	fileFilter
(Package privat) File	outputDirectory	The directory to write the source code to
(Package privat) 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

Von Klasse geerbte Felder com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

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

Von Schnittstelle geerbte Felder org.apache.maven.plugin.Mojo

ROLE

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
InfoClassMojo()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
private File	copyTemporaryTemplate()
(Package privat) InputStream	getTemplateSource()	Returns an input stream for the template source file for the info class
(Package privat) 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)

Von Klasse geerbte Methoden com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

addProperty, execute, init, initRepository, prepareParameters

Von Klasse geerbte Methoden org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Felddetails

BUILTIN_TEMPLATE_PATH

private static final String BUILTIN_TEMPLATE_PATH

Siehe auch:

• Konstantenfeldwerte

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

Konstruktordetails

InfoClassMojo

public InfoClassMojo()

Methodendetails

getTemplateSource

InputStream getTemplateSource()
                       throws IOException

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.

Gibt zurück:

An input stream for the template source file

Löst aus:

FileNotFoundException - if the template source cannot be found

IOException

run

public void run(GitRepository repository)
         throws MavanagaiataMojoException

Generates a info class filled providing information of the Git repository

Angegeben von:

run in Klasse AbstractGitMojo

Parameter:

repository - The repository instance to use

Löst aus:

MavanagaiataMojoException - if the info class cannot be generated

copyTemporaryTemplate

private File copyTemporaryTemplate()
                            throws IOException,
MavanagaiataMojoException

Löst aus:

IOException

MavanagaiataMojoException

getValueSource

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

Löst aus:

GitRepositoryException

writeSourceFile

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

Löst aus:

GitRepositoryException

MavanagaiataMojoException

org.apache.maven.shared.filtering.MavenFilteringException