Index

A B C D E F G H I J L M O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractGitRepository - Class in com.github.koraktor.mavanagaiata.git

An abstract implementation of a Git repository that provides basic and common functionality

AbstractGitRepository() - Constructor for class com.github.koraktor.mavanagaiata.git.AbstractGitRepository

B

BRANCH - Static variable in class com.github.koraktor.mavanagaiata.mojo.GitInfo

BranchMojo - Class in com.github.koraktor.mavanagaiata.mojo

This goal provides the currently checked out Git branch in the "mavanagaiata.branch" and "mvngit.branch" properties.

BranchMojo() - Constructor for class com.github.koraktor.mavanagaiata.mojo.BranchMojo

C

ChangelogDefaultFormat - Class in com.github.koraktor.mavanagaiata.mojo

ChangelogDefaultFormat() - Constructor for class com.github.koraktor.mavanagaiata.mojo.ChangelogDefaultFormat

ChangelogFormat - Class in com.github.koraktor.mavanagaiata.mojo

Base class for formatting changelog output

ChangelogFormat() - Constructor for class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

ChangelogFormat.Formats - Enum in com.github.koraktor.mavanagaiata.mojo

ChangelogMarkdownFormat - Class in com.github.koraktor.mavanagaiata.mojo

ChangelogMarkdownFormat() - Constructor for class com.github.koraktor.mavanagaiata.mojo.ChangelogMarkdownFormat

ChangelogMojo - Class in com.github.koraktor.mavanagaiata.mojo

This goal allows to generate a changelog of the currently checked out branch of the Git repository.

ChangelogMojo() - Constructor for class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo

check() - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Checks whether the Git repository is accessible.

check() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

CheckMojo - Class in com.github.koraktor.mavanagaiata.mojo

This goal checks various aspects of a Git repository to ensure it is in a valid state prior to a build

CheckMojo() - Constructor for class com.github.koraktor.mavanagaiata.mojo.CheckMojo

close() - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Closes any resources that are needed to access this repository

close() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

Closes any resources that are needed to access this repository

com.github.koraktor.mavanagaiata - package com.github.koraktor.mavanagaiata

com.github.koraktor.mavanagaiata.git - package com.github.koraktor.mavanagaiata.git

Generic Git abstraction classes

com.github.koraktor.mavanagaiata.git.jgit - package com.github.koraktor.mavanagaiata.git.jgit

JGit specific implementation details

com.github.koraktor.mavanagaiata.mojo - package com.github.koraktor.mavanagaiata.mojo

Maven mojo implementations and related code

COMMIT_ABBREV - Static variable in class com.github.koraktor.mavanagaiata.mojo.GitInfo

COMMIT_SHA - Static variable in class com.github.koraktor.mavanagaiata.mojo.GitInfo

CommitMojo - Class in com.github.koraktor.mavanagaiata.mojo

This goal provides the full ID of the current Git commit in the "mavanagaiata.commit.id", "mavanagaiata.commit.sha", "mvngit.commit.id", "mvngit.commit.sha" properties.

CommitMojo() - Constructor for class com.github.koraktor.mavanagaiata.mojo.CommitMojo

CommitWalkAction - Class in com.github.koraktor.mavanagaiata.git

Basic implementation of an action that is executed for each commit during a commit walk

CommitWalkAction() - Constructor for class com.github.koraktor.mavanagaiata.git.CommitWalkAction

ContributorsMojo - Class in com.github.koraktor.mavanagaiata.mojo

This goal allows to generate a list of contributors for the currently checked out branch of the Git repository.

ContributorsMojo() - Constructor for class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo

currentCommit - Variable in class com.github.koraktor.mavanagaiata.git.CommitWalkAction

D

dateFormat - Variable in class com.github.koraktor.mavanagaiata.mojo.BranchMojo

The date format to use for various dates

dateFormat - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo

The date format to use for various dates

dateFormat - Variable in class com.github.koraktor.mavanagaiata.mojo.CheckMojo

The date format to use for various dates

dateFormat - Variable in class com.github.koraktor.mavanagaiata.mojo.CommitMojo

The date format to use for various dates

dateFormat - Variable in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo

The date format to use for various dates

dateFormat - Variable in class com.github.koraktor.mavanagaiata.mojo.InfoClassMojo

The date format to use for various dates

dateFormat - Variable in class com.github.koraktor.mavanagaiata.mojo.TagMojo

The date format to use for various dates

DEFAULT - Enum constant in enum com.github.koraktor.mavanagaiata.mojo.ChangelogFormat.Formats

describe() - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Describes the current Git commit like git describe does

describe() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

DESCRIBE - Static variable in class com.github.koraktor.mavanagaiata.mojo.GitInfo

DIRTY - Static variable in class com.github.koraktor.mavanagaiata.mojo.GitInfo

E

execute() - Method in class com.github.koraktor.mavanagaiata.HelpMojo

execute() - Method in class com.github.koraktor.mavanagaiata.mojo.BranchMojo

Generic execution sequence for a Mavanagaiata mojo

execute() - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo

Generic execution sequence for a Mavanagaiata mojo

execute() - Method in class com.github.koraktor.mavanagaiata.mojo.CheckMojo

Generic execution sequence for a Mavanagaiata mojo

execute() - Method in class com.github.koraktor.mavanagaiata.mojo.CommitMojo

Generic execution sequence for a Mavanagaiata mojo

execute() - Method in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo

Generic execution sequence for a Mavanagaiata mojo

execute() - Method in class com.github.koraktor.mavanagaiata.mojo.InfoClassMojo

Generic execution sequence for a Mavanagaiata mojo

execute() - Method in class com.github.koraktor.mavanagaiata.mojo.TagMojo

Generic execution sequence for a Mavanagaiata mojo

execute(GitCommit) - Method in class com.github.koraktor.mavanagaiata.git.CommitWalkAction

Executes this action for the given commit

exists() - Method in class com.github.koraktor.mavanagaiata.git.MailMap

Returns whether a mail map has been found for the repository

F

format - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo

The format to use while generating the changelog

G

getAbbreviatedCommitId() - Method in class com.github.koraktor.mavanagaiata.git.AbstractGitRepository

getAbbreviatedCommitId() - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Returns the abbreviated commit SHA ID of the current Git commit

getAbbreviatedCommitId(GitCommit) - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Returns the abbreviated commit SHA ID of the given Git commit

getAbbreviatedCommitId(GitCommit) - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

getAuthorDate() - Method in interface com.github.koraktor.mavanagaiata.git.GitCommit

Returns the date when this commit has been authored

getAuthorEmailAddress() - Method in interface com.github.koraktor.mavanagaiata.git.GitCommit

Returns the email address of the author of this commit

getAuthorName() - Method in interface com.github.koraktor.mavanagaiata.git.GitCommit

Returns the name of the author of this commit

getAuthorTimeZone() - Method in interface com.github.koraktor.mavanagaiata.git.GitCommit

Returns the timezone in which this commit has been authored

getBranch() - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Returns the currently checked out branch of the Git repository

getBranch() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

getCanonicalAuthorEmailAddress(GitCommit) - Method in class com.github.koraktor.mavanagaiata.git.MailMap

Returns the canonical email address of the author of the given commit object

getCanonicalAuthorName(GitCommit) - Method in class com.github.koraktor.mavanagaiata.git.MailMap

Returns the canonical name of the author of the given commit object

getCanonicalCommitterEmailAddress(GitCommit) - Method in class com.github.koraktor.mavanagaiata.git.MailMap

Returns the canonical email address of the committer of the given commit object

getCanonicalCommitterName(GitCommit) - Method in class com.github.koraktor.mavanagaiata.git.MailMap

Returns the canonical name of the committer of the given commit object

getCommitterDate() - Method in interface com.github.koraktor.mavanagaiata.git.GitCommit

Returns the date when this commit has been committed

getCommitterEmailAddress() - Method in interface com.github.koraktor.mavanagaiata.git.GitCommit

Returns the email address of the committer

getCommitterName() - Method in interface com.github.koraktor.mavanagaiata.git.GitCommit

Returns the name of the committer

getCommitterTimeZone() - Method in interface com.github.koraktor.mavanagaiata.git.GitCommit

Returns the timezone in which this commit has been committed

getDate() - Method in interface com.github.koraktor.mavanagaiata.git.GitTag

Returns the date when this tag has been created

getHeadCommit() - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Returns the current HEAD commit of the Git repository

getHeadCommit() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

getHeadRef() - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Returns the Git ref used as the HEAD commit of the repository

getHeadRef() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

getId() - Method in interface com.github.koraktor.mavanagaiata.git.GitCommit

Returns the SHA hash ID of this commit

getMailMap() - Method in class com.github.koraktor.mavanagaiata.git.AbstractGitRepository

getMailMap() - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Returns a MailMap object that holds information from Git's .mailmap file

getMessage() - Method in interface com.github.koraktor.mavanagaiata.git.GitCommit

Returns the message of this commit

getMessageSubject() - Method in interface com.github.koraktor.mavanagaiata.git.GitCommit

Returns the subject of the commit's message

getName() - Method in interface com.github.koraktor.mavanagaiata.git.GitTag

Returns the name of this tag

getNextTagName() - Method in class com.github.koraktor.mavanagaiata.git.GitTagDescription

Returns the name of the next reachable tag

getOutputFile() - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo

Returns the output file for the generated changelog

getOutputFile() - Method in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo

Returns the output file for the generated contributors list

getTags() - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Returns a map of tags available in this repository

getTags() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

getTimeZone() - Method in interface com.github.koraktor.mavanagaiata.git.GitTag

Returns the timezone in which this tag has been created

getVersion() - Static method in class com.github.koraktor.mavanagaiata.mojo.GitInfo

getWorkTree() - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Returns the worktree of the repository

getWorkTree() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

GitCommit - Interface in com.github.koraktor.mavanagaiata.git

This interface specifies the basic properties needed for the mojos to access the information about a Git commit

GitInfo - Class in com.github.koraktor.mavanagaiata.mojo

GitInfo() - Constructor for class com.github.koraktor.mavanagaiata.mojo.GitInfo

GitRepository - Interface in com.github.koraktor.mavanagaiata.git

This interface specifies the basic properties needed for the mojos to access the information about a Git repository

GitRepositoryException - Exception Class in com.github.koraktor.mavanagaiata.git

An exception that can be thrown during Git repository actions

GitRepositoryException(String) - Constructor for exception class com.github.koraktor.mavanagaiata.git.GitRepositoryException

Create a new exception instance with the given message

GitRepositoryException(String, Throwable) - Constructor for exception class com.github.koraktor.mavanagaiata.git.GitRepositoryException

Create a new exception instance with the given message and cause

GitTag - Interface in com.github.koraktor.mavanagaiata.git

This interface specifies the basic properties needed for the mojos to access the information about a Git tag

GitTagDescription - Class in com.github.koraktor.mavanagaiata.git

Represents information about a Git commit like supplied by git describe

GitTagDescription(String, String, int) - Constructor for class com.github.koraktor.mavanagaiata.git.GitTagDescription

Create a new description for the given information

H

headRef - Variable in class com.github.koraktor.mavanagaiata.git.AbstractGitRepository

HelpMojo - Class in com.github.koraktor.mavanagaiata

Display help information on mavanagaiata.
Call mvn mavanagaiata:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

HelpMojo() - Constructor for class com.github.koraktor.mavanagaiata.HelpMojo

I

InfoClassMojo - Class in com.github.koraktor.mavanagaiata.mojo

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

InfoClassMojo() - Constructor for class com.github.koraktor.mavanagaiata.mojo.InfoClassMojo

init() - Method in class com.github.koraktor.mavanagaiata.mojo.BranchMojo

Generic initialization for all Mavanagaiata mojos

init() - Method in class com.github.koraktor.mavanagaiata.mojo.CommitMojo

Generic initialization for all Mavanagaiata mojos

init() - Method in class com.github.koraktor.mavanagaiata.mojo.InfoClassMojo

Generic initialization for all Mavanagaiata mojos

init() - Method in class com.github.koraktor.mavanagaiata.mojo.TagMojo

Generic initialization for all Mavanagaiata mojos

init() - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo

Initializes the output stream for the generated content

init() - Method in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo

Initializes the output stream for the generated content

init() - Method in class com.github.koraktor.mavanagaiata.mojo.CheckMojo

initConfiguration() - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo

initConfiguration() - Method in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo

Selects the attribute to use for sorting contributors

isChecked() - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Returns whether this repository instance has been checked

isChecked() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

isDirty(boolean) - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Returns whether the worktree of the repository is in a clean state

isDirty(boolean) - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

isLoaded() - Method in interface com.github.koraktor.mavanagaiata.git.GitTag

isMergeCommit() - Method in interface com.github.koraktor.mavanagaiata.git.GitCommit

isOnUnbornBranch() - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Returns whether this repository is currently on an “unborn” branch

isOnUnbornBranch() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

isTagged() - Method in class com.github.koraktor.mavanagaiata.git.GitTagDescription

Returns whether the commit is tagged

J

JGitRepository - Class in com.github.koraktor.mavanagaiata.git.jgit

Wrapper around JGit's Repository object to represent a Git repository

JGitRepository(File, File, String) - Constructor for class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

Creates a new instance for the given worktree and or Git directory

L

loadTag(GitTag) - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Load tag meta data

loadTag(GitTag) - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

M

MailMap - Class in com.github.koraktor.mavanagaiata.git

An implementation of Git's .mailmap functionality

MARKDOWN - Enum constant in enum com.github.koraktor.mavanagaiata.mojo.ChangelogFormat.Formats

O

outputFile - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo

The file to write the changelog to

P

project - Variable in class com.github.koraktor.mavanagaiata.mojo.BranchMojo

The Maven project

project - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo

The Maven project

project - Variable in class com.github.koraktor.mavanagaiata.mojo.CheckMojo

The Maven project

project - Variable in class com.github.koraktor.mavanagaiata.mojo.CommitMojo

The Maven project

project - Variable in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo

The Maven project

project - Variable in class com.github.koraktor.mavanagaiata.mojo.InfoClassMojo

The Maven project

project - Variable in class com.github.koraktor.mavanagaiata.mojo.TagMojo

The Maven project

R

run() - Method in class com.github.koraktor.mavanagaiata.git.CommitWalkAction

The code of the action that should be executed for each commit during a commit walk

run(GitRepository) - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo

Initializes the PrintStream to use

run(GitRepository) - Method in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo

Initializes the PrintStream to use

run(GitRepository) - Method in class com.github.koraktor.mavanagaiata.mojo.BranchMojo

Information about the currently checked out Git branch is retrieved using a JGit Repository instance

run(GitRepository) - Method in class com.github.koraktor.mavanagaiata.mojo.CheckMojo

run(GitRepository) - Method in class com.github.koraktor.mavanagaiata.mojo.CommitMojo

The ID (full and abbreviated) of the current Git commit out Git branch is retrieved using a JGit Repository instance

run(GitRepository) - Method in class com.github.koraktor.mavanagaiata.mojo.InfoClassMojo

Generates an info class filled providing information of the Git repository

run(GitRepository) - Method in class com.github.koraktor.mavanagaiata.mojo.TagMojo

This will first read all tags and walk the commit hierarchy down from HEAD until it finds one of the tags.

S

setHeadRef(String) - Method in class com.github.koraktor.mavanagaiata.git.AbstractGitRepository

setHeadRef(String) - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Sets the Git ref to use as the HEAD commit of the repository

setOutputFile(File) - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo

Sets the output file for the generated changelog

setOutputFile(File) - Method in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo

Sets the output file for the generated contributors list

T

TAG - Static variable in class com.github.koraktor.mavanagaiata.mojo.GitInfo

TagMojo - Class in com.github.koraktor.mavanagaiata.mojo

This goal provides the most recent Git tag in the "mavanagaiata.tag" and "mvngit.tag" properties.

TagMojo() - Constructor for class com.github.koraktor.mavanagaiata.mojo.TagMojo

toString() - Method in class com.github.koraktor.mavanagaiata.git.GitTagDescription

Returns the string representation of this description

V

valueOf(String) - Static method in enum com.github.koraktor.mavanagaiata.mojo.ChangelogFormat.Formats

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.koraktor.mavanagaiata.mojo.ChangelogFormat.Formats

Returns an array containing the constants of this enum type, in the order they are declared.

VERSION - Static variable in class com.github.koraktor.mavanagaiata.mojo.GitInfo

W

walkCommits(CommitWalkAction) - Method in interface com.github.koraktor.mavanagaiata.git.GitRepository

Runs the given action for all commits reachable from the current HEAD commit

walkCommits(CommitWalkAction) - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

writeOutput(GitRepository) - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo

Walks through the history of the currently checked out branch of the Git repository and builds a changelog from the commits contained in that branch.

writeOutput(GitRepository) - Method in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo

Walks through the history of the currently checked out branch of the Git repository and builds a list of contributors from the authors of the commits.

A B C D E F G H I J L M O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form