Nested and Inner Type Summary

Modifier and Type	Class and Description
public abstract static class	EnumNamingStrategies.DelegatingEnumNamingStrategy
public static class	EnumNamingStrategies.KebabCaseStrategy An implementation of `EnumNamingStrategy` that converts enum names in the typical upper snake case format to upper camel case format.
public static class	EnumNamingStrategies.LowerCamelCaseStrategy An implementation of `EnumNamingStrategy` that converts enum names in the typical upper snake case format to lower camel case format.
public static class	EnumNamingStrategies.LowerCaseStrategy An implementation of `EnumNamingStrategy` that converts enum names in the typical upper snake case format to upper camel case format.
public static class	EnumNamingStrategies.LowerDotCaseStrategy An implementation of `EnumNamingStrategy` that converts enum names in the typical upper snake case format to lower dot case format.
public static class	EnumNamingStrategies.SnakeCaseStrategy An implementation of `EnumNamingStrategy` that converts enum names in the typical upper snake case format to upper camel case format.
public static class	EnumNamingStrategies.UpperCamelCaseStrategy An implementation of `EnumNamingStrategy` that converts enum names in the typical upper snake case format to upper camel case format.
public static class	EnumNamingStrategies.UpperSnakeCaseStrategy An implementation of `EnumNamingStrategy` that converts enum names in the typical upper snake case format to upper camel case format.

Field Summary

Modifier and Type	Field and Description
public static final EnumNamingStrategy	KEBAB_CASE Naming convention used in languages like Lisp, where words are in lower-case letters, separated by hyphens.
public static final EnumNamingStrategy	LOWER_CAMEL_CASE Words other than first are capitalized and no separator is used between words.
public static final EnumNamingStrategy	LOWER_CASE Naming convention in which all words of the logical name are in lower case, and no separator is used between words.
public static final EnumNamingStrategy	LOWER_DOT_CASE Naming convention widely used as configuration properties name, where words are in lower-case letters, separated by dots.
public static final EnumNamingStrategy	SNAKE_CASE Naming convention used in languages like C, where words are in lower-case letters, separated by underscores.
public static final EnumNamingStrategy	UPPER_CAMEL_CASE Naming convention used in languages like Pascal, where all words are capitalized and no separator is used between words.
public static final EnumNamingStrategy	UPPER_SNAKE_CASE Naming convention in which the words are in upper-case letters, separated by underscores.

Access	Constructor and Description
private	EnumNamingStrategies()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

KEBAB_CASE back to summary

KEBAB_CASE	back to summary
public static final EnumNamingStrategy KEBAB_CASE Naming convention used in languages like Lisp, where words are in lower-case letters, separated by hyphens. See `EnumNamingStrategies.KebabCaseStrategy` for details. Example "ENUM_NAME" would be converted to "enum-name".

public static final EnumNamingStrategy KEBAB_CASE

Naming convention used in languages like Lisp, where words are in lower-case letters, separated by hyphens. See EnumNamingStrategies.KebabCaseStrategy for details.

Example "ENUM_NAME" would be converted to "enum-name".

LOWER_CAMEL_CASE back to summary

LOWER_CAMEL_CASE	back to summary
public static final EnumNamingStrategy LOWER_CAMEL_CASE Words other than first are capitalized and no separator is used between words. See `EnumNamingStrategies.LowerCamelCaseStrategy` for details. Example "ENUM_NAME" would be converted to "enumName".

public static final EnumNamingStrategy LOWER_CAMEL_CASE

Words other than first are capitalized and no separator is used between words. See EnumNamingStrategies.LowerCamelCaseStrategy for details.

Example "ENUM_NAME" would be converted to "enumName".

LOWER_CASE back to summary

LOWER_CASE	back to summary
public static final EnumNamingStrategy LOWER_CASE Naming convention in which all words of the logical name are in lower case, and no separator is used between words. See `EnumNamingStrategies.LowerCaseStrategy` for details. Example "ENUM_NAME" would be converted to "enumname".

public static final EnumNamingStrategy LOWER_CASE

Naming convention in which all words of the logical name are in lower case, and no separator is used between words. See EnumNamingStrategies.LowerCaseStrategy for details.

Example "ENUM_NAME" would be converted to "enumname".

LOWER_DOT_CASE back to summary

LOWER_DOT_CASE	back to summary
public static final EnumNamingStrategy LOWER_DOT_CASE Naming convention widely used as configuration properties name, where words are in lower-case letters, separated by dots. See `EnumNamingStrategies.LowerDotCaseStrategy` for details. Example "ENUM_NAME" would be converted to "enum.name".

public static final EnumNamingStrategy LOWER_DOT_CASE

Naming convention widely used as configuration properties name, where words are in lower-case letters, separated by dots. See EnumNamingStrategies.LowerDotCaseStrategy for details.

Example "ENUM_NAME" would be converted to "enum.name".

SNAKE_CASE back to summary

SNAKE_CASE	back to summary
public static final EnumNamingStrategy SNAKE_CASE Naming convention used in languages like C, where words are in lower-case letters, separated by underscores. See `EnumNamingStrategies.SnakeCaseStrategy` for details. Example "ENUM_NAME" would be converted to "enum_name".

public static final EnumNamingStrategy SNAKE_CASE

Naming convention used in languages like C, where words are in lower-case letters, separated by underscores. See EnumNamingStrategies.SnakeCaseStrategy for details.

Example "ENUM_NAME" would be converted to "enum_name".

UPPER_CAMEL_CASE back to summary

UPPER_CAMEL_CASE	back to summary
public static final EnumNamingStrategy UPPER_CAMEL_CASE Naming convention used in languages like Pascal, where all words are capitalized and no separator is used between words. See `EnumNamingStrategies.UpperCamelCaseStrategy` for details. Example "ENUM_NAME" would be converted to "EnumName".

public static final EnumNamingStrategy UPPER_CAMEL_CASE

Naming convention used in languages like Pascal, where all words are capitalized and no separator is used between words. See EnumNamingStrategies.UpperCamelCaseStrategy for details.

Example "ENUM_NAME" would be converted to "EnumName".

UPPER_SNAKE_CASE back to summary

UPPER_SNAKE_CASE	back to summary
public static final EnumNamingStrategy UPPER_SNAKE_CASE Naming convention in which the words are in upper-case letters, separated by underscores. See `EnumNamingStrategies.UpperSnakeCaseStrategy` for details. Example "ENUM_NAME" would be converted to "ENUM_NAME", but "__ENUM_NAME_" would also be converted to "ENUM_NAME".

public static final EnumNamingStrategy UPPER_SNAKE_CASE

Naming convention in which the words are in upper-case letters, separated by underscores. See EnumNamingStrategies.UpperSnakeCaseStrategy for details.

Example "ENUM_NAME" would be converted to "ENUM_NAME", but "__ENUM_NAME_" would also be converted to "ENUM_NAME".

EnumNamingStrategies	back to summary
private EnumNamingStrategies()

tools.jackson.databind back to summary

public abstract Class EnumNamingStrategies.DelegatingEnumNamingStrategy

Class Inheritance

extends Object
implements EnumNamingStrategy

java.lang.Object
tools.jackson.databind.EnumNamingStrategies.DelegatingEnumNamingStrategy

All Implemented Interfaces

tools.jackson.databind.EnumNamingStrategy

Known Direct Subclasses

tools.jackson.databind.EnumNamingStrategies.LowerCamelCaseStrategy, tools.jackson.databind.EnumNamingStrategies.UpperCamelCaseStrategy, tools.jackson.databind.EnumNamingStrategies.SnakeCaseStrategy, tools.jackson.databind.EnumNamingStrategies.UpperSnakeCaseStrategy, tools.jackson.databind.EnumNamingStrategies.LowerCaseStrategy, tools.jackson.databind.EnumNamingStrategies.KebabCaseStrategy, tools.jackson.databind.EnumNamingStrategies.LowerDotCaseStrategy

Field Summary

Modifier and Type	Field and Description
private final NamingStrategyImpls	strategy

Constructor Summary

Access	Constructor and Description
protected	DelegatingEnumNamingStrategy(NamingStrategyImpls strategy)

Method Summary

Modifier and Type	Method and Description
public String	convertEnumToExternalName(MapperConfig<?> config, AnnotatedClass cls, String enumName) Implements tools.jackson.databind.EnumNamingStrategy.convertEnumToExternalName. Translates the given `enumName` into an external property name according to the implementation of this `EnumNamingStrategy`.
private static int	nextIndexOfUnderscore(CharSequence sequence, int start)
private static String	normalizeWord(String word) Converts the first letter of the word to uppercase and the rest of the word to lowercase.
protected static String	Returns: the normalized enum name toBeanName(String the enum name to be normalized enumName) Normalizes the enum name to lower camel case in order to be further processed by a NamingStrategies

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

strategy	back to summary
private final NamingStrategyImpls strategy

Constructor Detail

DelegatingEnumNamingStrategy	back to summary
protected DelegatingEnumNamingStrategy(NamingStrategyImpls strategy)

Method Detail

convertEnumToExternalName back to summary

convertEnumToExternalName	back to summary
public String convertEnumToExternalName(MapperConfig<?> config, AnnotatedClass cls, String enumName) Implements tools.jackson.databind.EnumNamingStrategy.convertEnumToExternalName. Doc from tools.jackson.databind.EnumNamingStrategy.convertEnumToExternalName. Translates the given `enumName` into an external property name according to the implementation of this `EnumNamingStrategy`. Annotations @Override

public String convertEnumToExternalName(MapperConfig<?> config, AnnotatedClass cls, String enumName)

Implements tools.jackson.databind.EnumNamingStrategy.convertEnumToExternalName.

Doc from tools.jackson.databind.EnumNamingStrategy.convertEnumToExternalName.

Translates the given enumName into an external property name according to the implementation of this EnumNamingStrategy.

Annotations

@Override

nextIndexOfUnderscore	back to summary
private static int nextIndexOfUnderscore(CharSequence sequence, int start)

normalizeWord	back to summary
private static String normalizeWord(String word) Converts the first letter of the word to uppercase and the rest of the word to lowercase.

toBeanName	back to summary
protected static String toBeanName(String enumName) Normalizes the enum name to lower camel case in order to be further processed by a NamingStrategies Parameters enumName:String the enum name to be normalized Returns:String the normalized enum name

toBeanName

back to summary

protected static String toBeanName(String enumName)

Normalizes the enum name to lower camel case in order to be further processed by a NamingStrategies

Parameters

enumName:String: the enum name to be normalized

Returns:String

the normalized enum name

tools.jackson.databind back to summary

public Class EnumNamingStrategies.KebabCaseStrategy

Class Inheritance

extends DelegatingEnumNamingStrategy

java.lang.Object
tools.jackson.databind.EnumNamingStrategies.DelegatingEnumNamingStrategy
tools.jackson.databind.EnumNamingStrategies.KebabCaseStrategy

An implementation of EnumNamingStrategy that converts enum names in the typical upper snake case format to upper camel case format. This implementation first normalizes to lower camel case using (see LowerCamelCaseStrategy for details) and then uses PropertyNamingStrategies.KebabCaseStrategy to finish converting the name.

Warning

Naming conversion conflicts caused by underscore usage should be handled by client. e.g. Both PEANUT_BUTTER, PEANUT__BUTTER are converted into "peanut-butter". And "peanut-butter" will be deserialized into enum with smaller Enum.ordinal() value.

This results in the following example conversions:

"USER_NAME" is converted into "user-name"
"USER______NAME" is converted into "user-name"
"USERNAME" is converted into "username"
"User__Name" is converted into "user-name"
"_user_name" is converted into "user-name"
"_user_name_s" is converted into "user-name-s"
"__Username" is converted into "username"
"__username" is converted into "username"
"username" is converted into "username"
"Username" is converted into "username"

Field Summary

Modifier and Type	Field and Description
public static final EnumNamingStrategies.KebabCaseStrategy	INSTANCE An instance of `KebabCaseStrategy` for reuse.

Constructor Summary

Access	Constructor and Description
protected	KebabCaseStrategy()

Method Summary

Inherited from tools.jackson.databind.EnumNamingStrategies.DelegatingEnumNamingStrategy:: convertEnumToExternalName toBeanName

Field Detail

INSTANCE back to summary

INSTANCE	back to summary
public static final EnumNamingStrategies.KebabCaseStrategy INSTANCE An instance of `KebabCaseStrategy` for reuse. Since 2.19

public static final EnumNamingStrategies.KebabCaseStrategy INSTANCE

An instance of KebabCaseStrategy for reuse.

Since: 2.19

Constructor Detail

KebabCaseStrategy	back to summary
protected KebabCaseStrategy()

tools.jackson.databind back to summary

public Class EnumNamingStrategies.LowerCamelCaseStrategy

Class Inheritance

extends DelegatingEnumNamingStrategy

java.lang.Object
tools.jackson.databind.EnumNamingStrategies.DelegatingEnumNamingStrategy
tools.jackson.databind.EnumNamingStrategies.LowerCamelCaseStrategy

An implementation of EnumNamingStrategy that converts enum names in the typical upper snake case format to lower camel case format. This implementation follows three rules described below.

converts any character preceded by an underscore into upper case character, regardless of its original case (upper or lower).
converts any character NOT preceded by an underscore into a lower case character, regardless of its original case (upper or lower).
removes all underscores.

Warning

Naming conversion conflicts caused by underscore usage should be handled by client. e.g. Both PEANUT_BUTTER, PEANUT__BUTTER are converted into "peanutButter". And "peanutButter" will be deserialized into enum with smaller Enum.ordinal() value.

This results in the following example conversions:

"USER_NAME" is converted into "userName"
"USER______NAME" is converted into "userName"
"USERNAME" is converted into "username"
"User__Name" is converted into "userName"
"_user_name" is converted into "UserName"
"_user_name_s" is converted into "UserNameS"
"__Username" is converted into "Username"
"__username" is converted into "Username"
"username" is converted into "username"
"Username" is converted into "username"

Field Summary

Modifier and Type	Field and Description
public static final EnumNamingStrategies.LowerCamelCaseStrategy	INSTANCE An instance of `LowerCamelCaseStrategy` for reuse.

Constructor Summary

Access	Constructor and Description
protected	LowerCamelCaseStrategy()

Method Summary

Inherited from tools.jackson.databind.EnumNamingStrategies.DelegatingEnumNamingStrategy:: convertEnumToExternalName toBeanName

Field Detail

INSTANCE	back to summary
public static final EnumNamingStrategies.LowerCamelCaseStrategy INSTANCE An instance of `LowerCamelCaseStrategy` for reuse.

Constructor Detail

LowerCamelCaseStrategy	back to summary
protected LowerCamelCaseStrategy()

tools.jackson.databind back to summary

public Class EnumNamingStrategies.LowerCaseStrategy

Class Inheritance

extends DelegatingEnumNamingStrategy

java.lang.Object
tools.jackson.databind.EnumNamingStrategies.DelegatingEnumNamingStrategy
tools.jackson.databind.EnumNamingStrategies.LowerCaseStrategy

Warning

Naming conversion conflicts caused by underscore usage should be handled by client. e.g. Both PEANUT_BUTTER, PEANUT__BUTTER are converted into "peanutbutter". And "peanutbutter" will be deserialized into enum with smaller Enum.ordinal() value.

This results in the following example conversions:

"USER_NAME" is converted into "username"
"USER______NAME" is converted into "username"
"USERNAME" is converted into "username"
"User__Name" is converted into "username"
"_user_name" is converted into "username"
"_user_name_s" is converted into "usernames"
"__Username" is converted into "username"
"__username" is converted into "username"
"username" is converted into "username"
"Username" is converted into "username"

Field Summary

Modifier and Type	Field and Description
public static final EnumNamingStrategies.LowerCaseStrategy	INSTANCE An instance of `LowerCaseStrategy` for reuse.

Constructor Summary

Access	Constructor and Description
protected	LowerCaseStrategy()

Method Summary

Inherited from tools.jackson.databind.EnumNamingStrategies.DelegatingEnumNamingStrategy:: convertEnumToExternalName toBeanName

Field Detail

INSTANCE	back to summary
public static final EnumNamingStrategies.LowerCaseStrategy INSTANCE An instance of `LowerCaseStrategy` for reuse.

Constructor Detail

LowerCaseStrategy	back to summary
protected LowerCaseStrategy()

tools.jackson.databind back to summary

public Class EnumNamingStrategies.LowerDotCaseStrategy

Class Inheritance

extends DelegatingEnumNamingStrategy

java.lang.Object
tools.jackson.databind.EnumNamingStrategies.DelegatingEnumNamingStrategy
tools.jackson.databind.EnumNamingStrategies.LowerDotCaseStrategy

An implementation of EnumNamingStrategy that converts enum names in the typical upper snake case format to lower dot case format. This implementation first normalizes to lower camel case using (see LowerCamelCaseStrategy for details) and then uses PropertyNamingStrategies.LowerDotCaseStrategy to finish converting the name.

Warning

Naming conversion conflicts caused by underscore usage should be handled by client. e.g. Both PEANUT_BUTTER, PEANUT__BUTTER are converted into "peanut.butter". And "peanut.butter" will be deserialized into enum with smaller Enum.ordinal() value.

This results in the following example conversions:

"USER_NAME" is converted into "user.name"
"USER______NAME" is converted into "user.name"
"USERNAME" is converted into "username"
"User__Name" is converted into "user.name"
"_user_name" is converted into "user.name"
"_user_name_s" is converted into "user.name.s"
"__Username" is converted into "username"
"__username" is converted into "username"
"username" is converted into "username"
"Username" is converted into "username"

Field Summary

Modifier and Type	Field and Description
public static final EnumNamingStrategies.LowerDotCaseStrategy	INSTANCE An instance of `LowerDotCaseStrategy` for reuse.

Constructor Summary

Access	Constructor and Description
protected	LowerDotCaseStrategy()

Method Summary

Inherited from tools.jackson.databind.EnumNamingStrategies.DelegatingEnumNamingStrategy:: convertEnumToExternalName toBeanName

Field Detail

INSTANCE	back to summary
public static final EnumNamingStrategies.LowerDotCaseStrategy INSTANCE An instance of `LowerDotCaseStrategy` for reuse.

Constructor Detail

LowerDotCaseStrategy	back to summary
protected LowerDotCaseStrategy()

tools.jackson.databind back to summary

public Class EnumNamingStrategies.SnakeCaseStrategy

Class Inheritance

extends DelegatingEnumNamingStrategy

java.lang.Object
tools.jackson.databind.EnumNamingStrategies.DelegatingEnumNamingStrategy
tools.jackson.databind.EnumNamingStrategies.SnakeCaseStrategy

Warning

Naming conversion conflicts caused by underscore usage should be handled by client. e.g. Both PEANUT_BUTTER, PEANUT__BUTTER are converted into "peanut_butter". And "peanut_butter" will be deserialized into enum with smaller Enum.ordinal() value.

This results in the following example conversions:

"USER_NAME" is converted into "user_name"
"USER______NAME" is converted into "user_name"
"USERNAME" is converted into "username"
"User__Name" is converted into "user_name"
"_user_name" is converted into "user_name"
"_user_name_s" is converted into "user_name_s"
"__Username" is converted into "username"
"__username" is converted into "username"
"username" is converted into "username"
"Username" is converted into "username"

Field Summary

Modifier and Type	Field and Description
public static final EnumNamingStrategies.SnakeCaseStrategy	INSTANCE An instance of `SnakeCaseStrategy` for reuse.

Constructor Summary

Access	Constructor and Description
protected	SnakeCaseStrategy()

Method Summary

Inherited from tools.jackson.databind.EnumNamingStrategies.DelegatingEnumNamingStrategy:: convertEnumToExternalName toBeanName

Field Detail

INSTANCE	back to summary
public static final EnumNamingStrategies.SnakeCaseStrategy INSTANCE An instance of `SnakeCaseStrategy` for reuse.

Constructor Detail

SnakeCaseStrategy	back to summary
protected SnakeCaseStrategy()

tools.jackson.databind back to summary

public Class EnumNamingStrategies.UpperCamelCaseStrategy

Class Inheritance

extends DelegatingEnumNamingStrategy

java.lang.Object
tools.jackson.databind.EnumNamingStrategies.DelegatingEnumNamingStrategy
tools.jackson.databind.EnumNamingStrategies.UpperCamelCaseStrategy

Warning

Naming conversion conflicts caused by underscore usage should be handled by client. e.g. Both PEANUT_BUTTER, PEANUT__BUTTER are converted into "PeanutButter". And "PeanutButter" will be deserialized into enum with smaller Enum.ordinal() value.

This results in the following example conversions:

"USER_NAME" is converted into "UserName"
"USER______NAME" is converted into "UserName"
"USERNAME" is converted into "Username"
"User__Name" is converted into "UserName"
"_user_name" is converted into "UserName"
"_user_name_s" is converted into "UserNameS"
"__Username" is converted into "Username"
"__username" is converted into "Username"
"username" is converted into "Username"
"Username" is converted into "Username"

Field Summary

Modifier and Type	Field and Description
public static final EnumNamingStrategies.UpperCamelCaseStrategy	INSTANCE An instance of `LowerCamelCaseStrategy` for reuse.

Constructor Summary

Access	Constructor and Description
protected	UpperCamelCaseStrategy()

Method Summary

Inherited from tools.jackson.databind.EnumNamingStrategies.DelegatingEnumNamingStrategy:: convertEnumToExternalName toBeanName

Field Detail

INSTANCE	back to summary
public static final EnumNamingStrategies.UpperCamelCaseStrategy INSTANCE An instance of `LowerCamelCaseStrategy` for reuse.

Constructor Detail

UpperCamelCaseStrategy	back to summary
protected UpperCamelCaseStrategy()

tools.jackson.databind back to summary

public Class EnumNamingStrategies.UpperSnakeCaseStrategy

Class Inheritance

extends DelegatingEnumNamingStrategy

java.lang.Object
tools.jackson.databind.EnumNamingStrategies.DelegatingEnumNamingStrategy
tools.jackson.databind.EnumNamingStrategies.UpperSnakeCaseStrategy

Warning

Naming conversion conflicts caused by underscore usage should be handled by client. e.g. Both PEANUT_BUTTER, PEANUT__BUTTER are converted into "PEANUT_BUTTER". And "PEANUT_BUTTER" will be deserialized into enum with smaller Enum.ordinal() value.

This results in the following example conversions:

"USER_NAME" is converted into "USER_NAME"
"USER______NAME" is converted into "USER_NAME"
"USERNAME" is converted into "USERNAME"
"User__Name" is converted into "USER_NAME"
"_user_name" is converted into "USER_NAME"
"_user_name_s" is converted into "USER_NAME_S"
"__Username" is converted into "USERNAME"
"__username" is converted into "USERNAME"
"username" is converted into "USERNAME"
"Username" is converted into "USERNAME"

Field Summary

Modifier and Type	Field and Description
public static final EnumNamingStrategies.UpperSnakeCaseStrategy	INSTANCE An instance of `UpperSnakeCaseStrategy` for reuse.

Constructor Summary

Access	Constructor and Description
protected	UpperSnakeCaseStrategy()

Method Summary

Inherited from tools.jackson.databind.EnumNamingStrategies.DelegatingEnumNamingStrategy:: convertEnumToExternalName toBeanName

Field Detail

INSTANCE back to summary

INSTANCE	back to summary
public static final EnumNamingStrategies.UpperSnakeCaseStrategy INSTANCE An instance of `UpperSnakeCaseStrategy` for reuse. Since 2.19

public static final EnumNamingStrategies.UpperSnakeCaseStrategy INSTANCE

An instance of UpperSnakeCaseStrategy for reuse.

Since: 2.19

Constructor Detail

UpperSnakeCaseStrategy	back to summary
protected UpperSnakeCaseStrategy()