Package org.eclipse.jgit.lib
Enum Class CommitConfig.CleanupMode
- All Implemented Interfaces:
Serializable
,Comparable<CommitConfig.CleanupMode>
,Constable
,Config.ConfigEnum
- Enclosing class:
- CommitConfig
public static enum CommitConfig.CleanupMode
extends Enum<CommitConfig.CleanupMode>
implements Config.ConfigEnum
How to clean up commit messages when committing.
- Since:
- 6.1
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionUseSTRIP
for user-edited messages, otherwiseWHITESPACE
, unless overridden by a git config setting other than DEFAULT.Omit everything from the first "scissor" line on, then applyWHITESPACE
.WHITESPACE
, additionally remove comment lines.Make no changes.Remove trailing whitespace and leading and trailing empty lines; collapse multiple empty lines to a single one. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Checks if the given string matches with enum value.Converts enumeration value into a string to be save in config.static CommitConfig.CleanupMode
Returns the enum constant of this class with the specified name.static CommitConfig.CleanupMode[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
STRIP
WHITESPACE
, additionally remove comment lines. -
WHITESPACE
Remove trailing whitespace and leading and trailing empty lines; collapse multiple empty lines to a single one. -
VERBATIM
Make no changes. -
SCISSORS
Omit everything from the first "scissor" line on, then applyWHITESPACE
. -
DEFAULT
UseSTRIP
for user-edited messages, otherwiseWHITESPACE
, unless overridden by a git config setting other than DEFAULT.
-
-
Constructor Details
-
CleanupMode
private CleanupMode()
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
toConfigValue
Description copied from interface:Config.ConfigEnum
Converts enumeration value into a string to be save in config.- Specified by:
toConfigValue
in interfaceConfig.ConfigEnum
- Returns:
- the enum value as config string
-
matchConfigValue
Description copied from interface:Config.ConfigEnum
Checks if the given string matches with enum value.- Specified by:
matchConfigValue
in interfaceConfig.ConfigEnum
- Parameters:
in
- the string to match- Returns:
- true if the given string matches enum value, false otherwise
-