A B C D E F G H I J L M N O P R S T U V W
All Classes All Packages

A

abbrevCommitId - Variable in class com.github.koraktor.mavanagaiata.git.GitTagDescription

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

This abstract Mojo implements initializing a JGit Repository and provides this Repository instance to subclasses.

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

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

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.

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

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

addCommit(GitCommit) - Method in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo.Contributor

addProperty(String, String) - Method in class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

Saves a property with the given name into the project's properties The value will be stored two times – with "mavanagaiata" and "mvngit" as a prefix.

append(StringBuilder, String, int) - Method in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

Append a description to the buffer by respecting the indentSize and lineLength parameters.

apply(ChangelogFormat) - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

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

author - Variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

B

baseDir - Variable in class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

The working tree of the Git repository.

baseUrl - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

baseUrl - Variable in enum com.github.koraktor.mavanagaiata.mojo.ChangelogMojo.LinkToBaseUrl

branch - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

The format for the branch line

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

branchLink - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

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

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

branchOnlyLink - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

The format for the link to the branch history on GitHub

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

buildRepository(File, File) - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

BUILTIN_TEMPLATE_PATH - Static variable in class com.github.koraktor.mavanagaiata.mojo.InfoClassMojo

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

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

ChangelogMojo.LinkToBaseUrl - Enum in com.github.koraktor.mavanagaiata.mojo

Pre-defined base URLs used for links

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

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

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

Check whether the current branch is the given branch

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

Checks if the branch matches the configured name

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

Check if the working directory is clean

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

Checks if the worktree is in a clean state

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

Check whether the message of the current commit matches the given format

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

Checks if commit message matches the configured pattern

checked - Variable 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

CheckMojoException - Exception in com.github.koraktor.mavanagaiata.mojo

Exception type thrown during repository checks

CheckMojoException(CheckMojoException.Type, String...) - Constructor for exception com.github.koraktor.mavanagaiata.mojo.CheckMojoException

Creates a new exception for the given check failure type

CheckMojoException.Type - Enum in com.github.koraktor.mavanagaiata.mojo

Types of failures

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

Check whether the current commit is tagged

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

Checks if the the current HEAD is tagged

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

The name of the class to generate

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.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 - Variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

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

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

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

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

commitPrefix - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

The string to prepend to every commit message

committer - Variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

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

COMMONDIR_FILE - Static variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

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

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

The string to prepend to every contributor name

contributors - Variable in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo.ContributorsWalkAction

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

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

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

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

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

correctDistance(RevWalk, JGitTagCandidate, RevFlagSet) - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

Correct the distance for all tag candidates.

count - Variable in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo.Contributor

create(String, Throwable, Object...) - Static method in exception com.github.koraktor.mavanagaiata.mojo.MavanagaiataMojoException

Creates a new exception with the given message an cause

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

Creates a new JGit IndexDiff instance for this repository and worktree

createLinks - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

createPrintStream() - Method in class com.github.koraktor.mavanagaiata.mojo.AbstractGitOutputMojo

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

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

currentRef - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo.ChangelogWalkAction

D

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

The date format to use for various dates

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

dateFormatter - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

DEFAULT - com.github.koraktor.mavanagaiata.mojo.ChangelogFormat.Formats

DEFAULT_LINE_LENGTH - Static variable in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

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

DESCRIBE_FORMAT - Static variable in class com.github.koraktor.mavanagaiata.git.GitTagDescription

detail - Variable in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

If true, display all settable properties for each goal.

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

dirtyFlag - Variable in class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

The flag to append to refs if there are changes in the index or working tree

dirtyIgnoreUntracked - Variable in class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

Specifies if the dirty flag should also be appended if there are untracked files

distance - Variable in class com.github.koraktor.mavanagaiata.git.GitTagDescription

distance - Variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitTagCandidate

E

emailAddress - Variable in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo.Contributor

enableCreateLinks(String) - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

Enable creation of links using the given base URL

encoding - Variable in class com.github.koraktor.mavanagaiata.mojo.AbstractGitOutputMojo

The encoding to use for generated output

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

The encoding of the generated source file

equals(Object) - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

Compare an object to this one commit

equals(Object) - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitTag

escapeHtml - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

Whether to escape HTML

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

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

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

Returns an escaped form of the contributor name

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

Generic execution sequence for a Mavanagaiata mojo

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

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

Executes this action for the given commit

exists - Variable in class com.github.koraktor.mavanagaiata.git.MailMap

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

Returns whether a mail map has been found for the repository

F

failGracefully - Variable in class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

Specifies if a failed execution of the mojo will stop the build process

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

findNamedChild(Node, String) - Method in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

findSingleChild(Node, String) - Method in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

findTagCandidates(RevWalk, Map<String, GitTag>, RevFlagSet) - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

Find up to 10 tag candidates in the current branch.

firstCommit - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo.ChangelogWalkAction

firstCommitDate - Variable in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo.Contributor

flag - Variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitTagCandidate

footer - Variable in class com.github.koraktor.mavanagaiata.mojo.AbstractGitOutputMojo

The footer to print below the output

format - Variable in enum com.github.koraktor.mavanagaiata.mojo.ChangelogFormat.Formats

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

The format to use while generating the changelog

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

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

The formatting template to use while generating the changelog

G

generateOutput(GitRepository) - Method in class com.github.koraktor.mavanagaiata.mojo.AbstractGitOutputMojo

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

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

getAuthorDate() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

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

Returns the email address of the author of this commit

getAuthorEmailAddress() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

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

Returns the name of the author of this commit

getAuthorName() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

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

Returns the timezone in which this commit has been authored

getAuthorTimeZone() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

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

getCanonicalMail(String, String) - Method in class com.github.koraktor.mavanagaiata.git.MailMap

Returns the canonical email address for the given name and email address pair

getCanonicalName(String, String) - Method in class com.github.koraktor.mavanagaiata.git.MailMap

Returns the canonical name for the given name and email address pair

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

Returns the date when this commit has been committed

getCommitterDate() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

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

Returns the email address of the committer

getCommitterEmailAddress() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

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

Returns the name of the committer

getCommitterName() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

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

Returns the timezone in which this commit has been committed

getCommitterTimeZone() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

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

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

Returns the date when this tag has been created

getDate() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitTag

getDistance() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitTagCandidate

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

getFormat() - Method in enum com.github.koraktor.mavanagaiata.mojo.ChangelogFormat.Formats

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

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

Returns the object for the Git ref currently set as HEAD

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

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

Returns a commit object for HEAD

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

Returns the SHA hash ID of this commit

getId() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

getIndentLevel(String) - Static method in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

Gets the indentation level of the specified line.

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

getMessage() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

getMessageForType(CheckMojoException.Type, String...) - Static method in exception com.github.koraktor.mavanagaiata.mojo.CheckMojoException

Returns a message for the given type and (optional) arguments

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

Returns the subject of the commit's message

getMessageSubject() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

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

Returns the name of this tag

getName() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitTag

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

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.AbstractGitOutputMojo

Returns the output file for the generated content

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

getPropertyFromExpression(String) - Method in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

getReader(Reader) - Method in class com.github.koraktor.mavanagaiata.mojo.InfoClassMojo.ValueSourceFilter

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

Creates a new JGit FileRepositoryBuilder instance

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

getSingleChild(Node, String) - Method in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

getTag() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitTagCandidate

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

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

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

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

Returns the timezone in which this tag has been created

getTimeZone() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitTag

getValue(Node, String) - Method in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

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

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

getVersion() - Static method in interface com.github.koraktor.mavanagaiata.mojo.VersionHelper

Returns the current version of Mavanagaiata This requires the presence of the generated Git info class.

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

gitDir - Variable in class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

The GIT_DIR path of the Git repository

GITDIR_FILE - Static variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

GITHUB - com.github.koraktor.mavanagaiata.mojo.ChangelogMojo.LinkToBaseUrl

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

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

GITLAB - com.github.koraktor.mavanagaiata.mojo.ChangelogMojo.LinkToBaseUrl

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 in com.github.koraktor.mavanagaiata.git

An exception that can be thrown during Git repository actions

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

Create a new exception instance with the given message

GitRepositoryException(String, Throwable) - Constructor for exception 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, GitTag, int) - Constructor for class com.github.koraktor.mavanagaiata.git.GitTagDescription

Create a new description for the given information

goal - Variable in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

The name of the goal for which to show help.

H

hashCode() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

Returns the hash code of the underlying commit's ID string

hashCode() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitTag

head - Variable in class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

The commit or ref to use as starting point for operations

headCommit - Variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

header - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

The header to print above the changelog

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

The header to print above the changelog

headObject - Variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

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

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

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.mojo.HelpMojo

I

incrementDistanceIfExcludes(RevCommit) - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitTagCandidate

Increments the distance of this tag candidate if the given commit has not been seen already

indentSize - Variable in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

The number of spaces per indentation level, should be positive.

INDEX_FILE - Static variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

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

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

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

Generic initialization for all Mavanagaiata mojos

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

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.AbstractGitOutputMojo

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

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

Compiles the commit message check regex

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

Selects the attribute to use for sorting contributors

initRepository() - Method in class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

Initializes a JGit Repository object for further reference

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

isGraceful() - Method in exception com.github.koraktor.mavanagaiata.mojo.CheckMojoException

isGraceful() - Method in exception com.github.koraktor.mavanagaiata.mojo.MavanagaiataMojoException

Returns whether this exception should lead to a graceful build failure

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

isLoaded() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitTag

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

isMergeCommit() - Method in class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

isNotEmpty(String) - Static method in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

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

Returns whether this repository is currently on an “unborn” branch An “unborn” branch is a branch without any actual commits.

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

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

Wrapper around JGit's RevCommit object to represent a Git commit

JGitCommit(RevCommit) - Constructor for class com.github.koraktor.mavanagaiata.git.jgit.JGitCommit

Creates a new instance from a JGit commit object

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

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

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

Creates a new empty instance

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

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

Wrapper around JGit's RevTag object to represent a Git tag

JGitTag(RevTag) - Constructor for class com.github.koraktor.mavanagaiata.git.jgit.JGitTag

Creates a new instance from a JGit tag object

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

This class represents a tag candidate which could be the latest tag in the

JGitTagCandidate(JGitTag, int, RevFlag) - Constructor for class com.github.koraktor.mavanagaiata.git.jgit.JGitTagCandidate

Create a new tag candidate instance with the given attributes

L

lineLength - Variable in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

The maximum length of a display line, should be positive.

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

Used to select the service to create links to

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

Can be used to override the pre-defined URLs from ChangelogMojo.linkTo with a customized URL

LinkToBaseUrl(String) - Constructor for enum com.github.koraktor.mavanagaiata.mojo.ChangelogMojo.LinkToBaseUrl

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

The project name for GitHub links

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

The user name for GitHub links

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

MAIL_TO_MAIL_PATTERN - Static variable in class com.github.koraktor.mavanagaiata.git.MailMap

MAIL_TO_NAME_AND_MAIL_PATTERN - Static variable in class com.github.koraktor.mavanagaiata.git.MailMap

MAIL_TO_NAME_PATTERN - Static variable in class com.github.koraktor.mavanagaiata.git.MailMap

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

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

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

An implementation of Git's .mailmap functionality

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

Creates a new mail map instance

MAILMAP_FILE - Static variable in class com.github.koraktor.mavanagaiata.git.MailMap

mailToMailMap - Variable in class com.github.koraktor.mavanagaiata.git.MailMap

mailToNameAndMailMap - Variable in class com.github.koraktor.mavanagaiata.git.MailMap

mailToNameMap - Variable in class com.github.koraktor.mavanagaiata.git.MailMap

MARKDOWN - com.github.koraktor.mavanagaiata.mojo.ChangelogFormat.Formats

MARKDOWN_TRANSLATION_MAP - Static variable in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo

MARKDOWN_TRANSLATOR - Static variable in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo

MavanagaiataMojoException - Exception in com.github.koraktor.mavanagaiata.mojo

A generic exception used to relay an error during mojo execution

MavanagaiataMojoException(String, Throwable) - Constructor for exception com.github.koraktor.mavanagaiata.mojo.MavanagaiataMojoException

Creates a new exception with the given message and cause

MAX_DESCRIBE_CANDIDATES - Static variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

N

name - Variable in class com.github.koraktor.mavanagaiata.mojo.ContributorsMojo.Contributor

NAME_AND_MAIL_TO_NAME_AND_MAIL_PATTERN - Static variable in class com.github.koraktor.mavanagaiata.git.MailMap

nameAndMailToNameAndMailMap - Variable in class com.github.koraktor.mavanagaiata.git.MailMap

nextTag - Variable in class com.github.koraktor.mavanagaiata.git.GitTagDescription

O

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

The directory to write the source code to

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

The file to write the changelog to

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

The file to write the contributors list to

P

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

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

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

Tries to parse the .mailmap file from the worktree of the given repository.

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

Tries to parse the given file using the rules from git-shortlog.

PLUGIN_HELP_PATH - Static variable in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

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

Prepare the walk action

prepare() - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

Prepare the format strings for use

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

prepareParameters() - Method in class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

Prepares and validates user-supplied parameters

printBranch(String) - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

Print a section header for a branch

printCommit(GitCommit) - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

Print a single line for a commit

printCompareLink(String, String, boolean) - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

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

printHeader() - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

Print a header for the changelog

printSeparator() - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

Print a separator between sections

printStream - Variable in class com.github.koraktor.mavanagaiata.mojo.AbstractGitOutputMojo

printStream - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

printTag(GitTag) - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

Print a section header for a tag

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

The Maven project

propertyPrefixes - Variable in class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

The prefixes to prepend to property keys

R

REF_LINK_PREFIX - Static variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

repeat(String, int) - Static method in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

Repeat a String n times to form a new string.

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

repository - Variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitRepository

repository - Variable in class com.github.koraktor.mavanagaiata.git.MailMap

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() - Method in class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo.ChangelogWalkAction

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

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

The actual implementation of the mojo

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

Initializes the PrintStream to use This is System.out if no output file is given (default).

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 a 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

separator - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

THe separator to print between different sections of the changelog

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.AbstractGitOutputMojo

Sets the output file for the generated content

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

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

Sets the repository this action should be executed in

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

Whether the number of contributions should be listed

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

Whether the email addresses of contributors should be listed

skip - Variable in class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

Skip the plugin execution

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

Whether to skip commits that match the given regular expression

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

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

Whether to skip merge commits’ messages

skipNoGit - Variable in class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

Skip the plugin execution if not inside a Git repository

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

Whether to skip tagged commits' messages
This is useful when usually tagging commits like "Version bump to X.Y.Z"

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

The method used to sort contributors

T

tag - Variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitTag

tag - Variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitTagCandidate

tag - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

The format for a tag line

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

taggerIdent - Variable in class com.github.koraktor.mavanagaiata.git.jgit.JGitTag

tagLink - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogFormat

The format for the link to the tag history on GitHub

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

tags - Variable in class com.github.koraktor.mavanagaiata.mojo.ChangelogMojo.ChangelogWalkAction

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

The path to an alternative template for the info class

toLines(String, int, int, int) - Static method in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

Splits the specified text into lines of convenient display length.

toLines(List<String>, String, int, int) - Static method in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

Adds the specified line to the output sequence, performing line wrapping if necessary.

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

Returns the string representation of this description

type - Variable in exception com.github.koraktor.mavanagaiata.mojo.CheckMojoException

Type() - Constructor for enum com.github.koraktor.mavanagaiata.mojo.CheckMojoException.Type

U

UNCLEAN - com.github.koraktor.mavanagaiata.mojo.CheckMojoException.Type

unescapeFormatNewlines(String) - Static method in class com.github.koraktor.mavanagaiata.mojo.AbstractGitOutputMojo

Unescapes newlines for format strings

UNTAGGED - com.github.koraktor.mavanagaiata.mojo.CheckMojoException.Type

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.

valueOf(String) - Static method in enum com.github.koraktor.mavanagaiata.mojo.ChangelogMojo.LinkToBaseUrl

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

valueOf(String) - Static method in enum com.github.koraktor.mavanagaiata.mojo.CheckMojoException.Type

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.

values() - Static method in enum com.github.koraktor.mavanagaiata.mojo.ChangelogMojo.LinkToBaseUrl

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

values() - Static method in enum com.github.koraktor.mavanagaiata.mojo.CheckMojoException.Type

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

valueSource - Variable in class com.github.koraktor.mavanagaiata.mojo.InfoClassMojo.ValueSourceFilter

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

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

VersionHelper - Interface in com.github.koraktor.mavanagaiata.mojo

Helper class that provides the current version of Mavanagaiata to the mojo instances

W

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

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

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

writeGoal(StringBuilder, String, Element) - Method in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

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

This must be implemented by mojos for writing their output

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.

writeParameter(StringBuilder, Node, Node) - Method in class com.github.koraktor.mavanagaiata.mojo.HelpMojo

writeSourceFile(GitRepository, File) - Method in class com.github.koraktor.mavanagaiata.mojo.InfoClassMojo

WRONG_BRANCH - com.github.koraktor.mavanagaiata.mojo.CheckMojoException.Type

WRONG_COMMIT_MSG - com.github.koraktor.mavanagaiata.mojo.CheckMojoException.Type

A B C D E F G H I J L M N O P R S T U V W
All Classes All Packages