Module org.eclipse.jgit

Package org.eclipse.jgit.lib

Class CommitConfig

java.lang.Object

org.eclipse.jgit.lib.CommitConfig

public class CommitConfig
extends Object

The standard "commit" configuration parameters.

Since:

5.13

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CommitConfig.CleanupMode	How to clean up commit messages when committing.

Field Summary

Fields

Modifier and Type	Field	Description
static final Config.SectionParser<CommitConfig>	KEY	Key for Config.get(SectionParser).

Method Summary

Modifier and Type	Method	Description
static String	cleanText(String text, CommitConfig.CleanupMode mode, char commentChar)	Processes a text according to the given CommitConfig.CleanupMode.
static char	determineCommentChar(String text)	Determines a comment character by choosing one from a limited set of 7-bit ASCII characters that do not occur in the given text at the beginning of any line.
CommitConfig.CleanupMode	getCleanupMode()	Retrieves the CommitConfig.CleanupMode as given by git config commit.cleanup.
char	getCommentChar()	Retrieves the comment character set by git config core.commentChar.
char	getCommentChar(String text)	Determines the comment character to use for a particular text.
String	getCommitEncoding()	Get the encoding of the commit as defined in the git i18n.commitEncoding property.
String	getCommitTemplateContent(Repository repository)	Get the content to the commit template as defined in commit.template.
String	getCommitTemplatePath()	Get the path to the commit template as defined in the git commit.template property.
boolean	isAutoCommentChar()	Tells whether the comment character should be determined by choosing a character not occurring in a commit message.
CommitConfig.CleanupMode	resolve(CommitConfig.CleanupMode mode, boolean defaultStrip)	Computes a non-default CommitConfig.CleanupMode from the given mode and the git config.

Methods inherited from class java.lang.Object

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

Field Details

KEY

public static final Config.SectionParser<CommitConfig> KEY

Key for Config.get(SectionParser).

Method Details

getCommitTemplatePath

@Nullable
public String getCommitTemplatePath()

Get the path to the commit template as defined in the git commit.template property.

Returns:

the path to commit template or null if not present.

getCommitEncoding

@Nullable
public String getCommitEncoding()

Get the encoding of the commit as defined in the git i18n.commitEncoding property.

Returns:

the encoding or null if not present.

getCommentChar

public char getCommentChar()

Retrieves the comment character set by git config core.commentChar.

Returns:

the character to use for comments in commit messages

Since:

6.2

getCommentChar

public char getCommentChar(String text)

Determines the comment character to use for a particular text. If core.commentChar is "auto", tries to determine an unused character; if none is found, falls back to '#'. Otherwise returns the character given by core.commentChar.

Parameters:

text - existing text

Returns:

the character to use

Since:

6.2

isAutoCommentChar

public boolean isAutoCommentChar()

Tells whether the comment character should be determined by choosing a character not occurring in a commit message.

Returns:

true if git config core.commentChar is "auto"

Since:

6.2

getCleanupMode

@NonNull
public CommitConfig.CleanupMode getCleanupMode()

Retrieves the CommitConfig.CleanupMode as given by git config commit.cleanup.

Returns:

the CommitConfig.CleanupMode; CommitConfig.CleanupMode.DEFAULT if the git config is not set

Since:

6.1

resolve

@NonNull
public CommitConfig.CleanupMode resolve(@NonNull
 CommitConfig.CleanupMode mode,
 boolean defaultStrip)

Computes a non-default CommitConfig.CleanupMode from the given mode and the git config.

Parameters:

mode - CommitConfig.CleanupMode to resolve

defaultStrip - if true return CommitConfig.CleanupMode.STRIP if the git config is also "default", otherwise return CommitConfig.CleanupMode.WHITESPACE

Returns:

the mode, if it is not CommitConfig.CleanupMode.DEFAULT, otherwise the resolved mode, which is never CommitConfig.CleanupMode.DEFAULT

Since:

6.1

getCommitTemplateContent

@Nullable
public String getCommitTemplateContent(@NonNull
 Repository repository)
                                throws FileNotFoundException,
IOException,
ConfigInvalidException

Get the content to the commit template as defined in commit.template. If no i18n.commitEncoding is specified, UTF-8 fallback is used.

Parameters:

repository - to resolve relative path in local git repo config

Returns:

content of the commit template or null if not present.

Throws:

IOException - if the template file can not be read

FileNotFoundException - if the template file does not exists

ConfigInvalidException - if a commitEncoding is specified and is invalid

Since:

6.0

cleanText

public static String cleanText(@NonNull
 String text,
 @NonNull
 CommitConfig.CleanupMode mode,
 char commentChar)

Processes a text according to the given CommitConfig.CleanupMode.

Parameters:

text - text to process

mode - CommitConfig.CleanupMode to use

commentChar - comment character (normally #) to use if mode is CommitConfig.CleanupMode.STRIP or CommitConfig.CleanupMode.SCISSORS

Returns:

the processed text

Throws:

IllegalArgumentException - if mode is CommitConfig.CleanupMode.DEFAULT (use resolve(CleanupMode, boolean) first)

Since:

6.1

determineCommentChar

public static char determineCommentChar(String text)

Determines a comment character by choosing one from a limited set of 7-bit ASCII characters that do not occur in the given text at the beginning of any line. If none can be determined, (char) 0 is returned.

Parameters:

text - to get a comment character for

Returns:

the comment character, or (char) 0 if none could be determined

Since:

6.2