Package com.github.koraktor.mavanagaiata.mojo

Class AbstractGitOutputMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

com.github.koraktor.mavanagaiata.mojo.AbstractGitOutputMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

ChangelogMojo, ContributorsMojo

abstract class AbstractGitOutputMojo
extends AbstractGitMojo

This abstract Mojo implements writing output to a PrintStream This is either System.out by default, but maybe another PrintStream object wrapped around a file given by outputFile.

Since:

0.2.2

Author:

Sebastian Staudt

See Also:

File, PrintStream

Field Summary

Fields

Modifier and Type	Field	Description
(package private) String	encoding	The encoding to use for generated output
(package private) String	footer	The footer to print below the output
(package private) PrintStream	printStream

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
AbstractGitOutputMojo()

Method Summary

Modifier and Type	Method	Description
(package private) PrintStream	createPrintStream()	Creates a new print stream for the configured output file and encoding
(package private) void	generateOutput(GitRepository repository)	Writes the (optional) footer and flushes the PrintStream after calling the main mojo implementation
abstract File	getOutputFile()	Returns the output file for the generated content
protected GitRepository	init()	Initializes the output stream for the generated content
protected void	initConfiguration()
protected void	run(GitRepository repository)	Initializes the PrintStream to use This is System.out if no output file is given (default).
abstract void	setOutputFile(File outputFile)	Sets the output file for the generated content
(package private) static String	unescapeFormatNewlines(String format)	Unescapes newlines for format strings
protected abstract void	writeOutput(GitRepository repository)	This must be implemented by mojos for writing their output

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

addProperty, execute, 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

encoding

@Parameter(property="mavanagaiata.encoding",
           defaultValue="UTF-8")
String encoding

The encoding to use for generated output

footer

@Parameter(property="mavanagaiata.footer",
           defaultValue="\nGenerated by Mavanagaiata %s at %s")
String footer

The footer to print below the output

printStream

PrintStream printStream

Constructor Detail

AbstractGitOutputMojo

AbstractGitOutputMojo()

Method Detail

unescapeFormatNewlines

static String unescapeFormatNewlines(String format)

Unescapes newlines for format strings

Parameters:

format - The escaped format string

Returns:

The unescaped format string

initConfiguration

protected void initConfiguration()

init

protected GitRepository init()
                      throws MavanagaiataMojoException

Initializes the output stream for the generated content

Overrides:

init in class AbstractGitMojo

Returns:

false if the execution should be skipped

Throws:

MavanagaiataMojoException - if the output file can not be opened

getOutputFile

public abstract File getOutputFile()

Returns the output file for the generated content

Has to be implemented by subclassing mojos, so that the output file can be easily configured.

Returns:

The output file for the generated content

run

protected final void run(GitRepository repository)
                  throws MavanagaiataMojoException

Initializes the PrintStream to use This is System.out if no output file is given (default). Otherwise the parent directories of outputFile are created and a new PrintStream for that file is created.

Specified by:

run in class AbstractGitMojo

Parameters:

repository - The repository instance to use

Throws:

MavanagaiataMojoException - if the file specified by outputFile cannot be opened for writing or the target directory cannot be created

createPrintStream

PrintStream createPrintStream()
                       throws FileNotFoundException,
                              UnsupportedEncodingException

Creates a new print stream for the configured output file and encoding

Returns:

A new print stream

Throws:

FileNotFoundException - if the output file could not be found

UnsupportedEncodingException - if the encoding is not supported

setOutputFile

public abstract void setOutputFile(File outputFile)

Sets the output file for the generated content

Parameters:

outputFile - The output file for the generated content

writeOutput

protected abstract void writeOutput(GitRepository repository)
                             throws MavanagaiataMojoException

This must be implemented by mojos for writing their output

Parameters:

repository - The repository the mojo is running in

Throws:

MavanagaiataMojoException - if the output cannot be generated

generateOutput

void generateOutput(GitRepository repository)
             throws MavanagaiataMojoException

Writes the (optional) footer and flushes the PrintStream after calling the main mojo implementation

Parameters:

repository - The repository the mojo is running in

Throws:

MavanagaiataMojoException - if the output cannot be generated

See Also:

writeOutput(com.github.koraktor.mavanagaiata.git.GitRepository)