Package com.github.koraktor.mavanagaiata.mojo

Klasse ChangelogFormat

java.lang.Object

com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

Bekannte direkte Unterklassen:

ChangelogDefaultFormat

public class ChangelogFormat
extends Object

Base class for formatting changelog output

Individual properties can be overridden in the configuration of the changelog mojo.

Autor:

Sebastian Staudt

Siehe auch:

• ChangelogMojo
• ChangelogDefaultFormat
• ChangelogMarkdownFormat

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static enum	ChangelogFormat.Formats

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
(Package privat) String	baseUrl
(Package privat) String	branch	The format for the branch line
(Package privat) String	branchLink	The format for the link to the history from the last tag to the current branch on GitHub
(Package privat) String	branchOnlyLink	The format for the link to the branch history on GitHub
(Package privat) String	commitPrefix	The string to prepend to every commit message
(Package privat) Boolean	createLinks
(Package privat) String	dateFormat
(Package privat) SimpleDateFormat	dateFormatter
(Package privat) Boolean	escapeHtml	Whether to escape HTML
(Package privat) String	header	The header to print above the changelog
(Package privat) PrintStream	printStream
(Package privat) String	separator	THe separator to print between different sections of the changelog
(Package privat) String	tag	The format for a tag line
(Package privat) String	tagLink	The format for the link to the tag history on GitHub

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
ChangelogFormat()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
(Package privat) ChangelogFormat	apply(ChangelogFormat format)	Create a new format instance using this instance as base and override with (non-null) properties of the given format
(Package privat) void	enableCreateLinks(String baseUrl)	Enable creation of links using the given base URL
(Package privat) void	prepare()	Prepare the format strings for use
(Package privat) void	printBranch(String branchName)	Print a section header for a branch
(Package privat) void	printCommit(GitCommit currentCommit)	Print a single line for a commit
(Package privat) void	printCompareLink(String currentRef, String lastRef, boolean isBranch)	Generates a link to the GitHub compare / commits view and inserts it into the changelog
(Package privat) void	printHeader()	Print a header for the changelog
(Package privat) void	printSeparator()	Print a separator between sections
(Package privat) void	printTag(GitTag currentTag)	Print a section header for a tag

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

baseUrl

String baseUrl

branch

String branch

The format for the branch line

branchLink

String branchLink

The format for the link to the history from the last tag to the current branch on GitHub

branchOnlyLink

String branchOnlyLink

The format for the link to the branch history on GitHub

dateFormatter

SimpleDateFormat dateFormatter

dateFormat

String dateFormat

commitPrefix

String commitPrefix

The string to prepend to every commit message

createLinks

Boolean createLinks

escapeHtml

Boolean escapeHtml

Whether to escape HTML

header

String header

The header to print above the changelog

printStream

PrintStream printStream

separator

String separator

THe separator to print between different sections of the changelog

tag

String tag

The format for a tag line

tagLink

String tagLink

The format for the link to the tag history on GitHub

Konstruktordetails

ChangelogFormat

public ChangelogFormat()

Methodendetails

apply

ChangelogFormat apply(ChangelogFormat format)

Create a new format instance using this instance as base and override with (non-null) properties of the given format

Parameter:

format - Format to apply settings from

Gibt zurück:

A new format with applied settings

enableCreateLinks

void enableCreateLinks(String baseUrl)

Enable creation of links using the given base URL

Parameter:

baseUrl - The base URL to link to

prepare

void prepare()

Prepare the format strings for use

printBranch

void printBranch(String branchName)

Print a section header for a branch

Parameter:

branchName - The name of the branch

printCommit

void printCommit(GitCommit currentCommit)

Print a single line for a commit

Parameter:

currentCommit - The commit to print

printCompareLink

void printCompareLink(String currentRef,
 String lastRef,
 boolean isBranch)

Generates a link to the GitHub compare / commits view and inserts it into the changelog

If no current ref is provided, the generated text will link to the commits view, listing all commits of the latest tag or the whole branch. Otherwise the text will link to the compare view, listing all commits that are in the current ref, but not in the last one.

Parameter:

currentRef - The current tag or branch in the changelog

lastRef - The last tag or branch in the changelog

isBranch - Whether the current ref is a branch

printHeader

void printHeader()

Print a header for the changelog

printSeparator

void printSeparator()

Print a separator between sections

printTag

void printTag(GitTag currentTag)

Print a section header for a tag

Parameter:

currentTag - The tag