Default (empty) implementation returns suggested ("implicit" or "default") name unmodified
Note that the strategy is guaranteed to be called once per logical property (which may be represented by multiple members; such as pair of a getter and a setter), but may be called for each: implementations should not count on exact number of times, and should work for any member that represent a property. Also note that calls are made during construction of serializers and deserializers which are typically cached, and not for every time serializer or deserializer is called.
In absence of a registered custom strategy, the default Java property naming strategy is used, which leaves field names as is, and removes set/get/is prefix from methods (as well as lower-cases initial sequence of capitalized characters).
Note
Since 2.12 sub-classes defined here (as well as static singleton instances thereof)
are deprecated due to
databind#2715.
Please use constants and classes in PropertyNamingStrategies instead.
| Modifier and Type | Class and Description |
|---|---|
| public static class | PropertyNamingStrategy.
Deprecated
Since 2.12 use
PropertyNamingStrategies. instead
(see
databind#2715
for reason for deprecation)
|
| public static class | PropertyNamingStrategy.
Deprecated
Since 2.12 use
PropertyNamingStrategies. instead
(see
databind#2715
for reason for deprecation)
|
| public static class | PropertyNamingStrategy.
Deprecated
Since 2.12 use
PropertyNamingStrategies. instead
(see
databind#2715
for reason for deprecation)
|
| public abstract static class | PropertyNamingStrategy.
Deprecated
Since 2.12 deprecated. See
databind#2715
for reasons for deprecation.
|
| public static class | PropertyNamingStrategy.
Deprecated
Since 2.12 use
PropertyNamingStrategies. instead
(see
databind#2715
for reason for deprecation)
|
| public static class | PropertyNamingStrategy.
Deprecated
Since 2.12 use
PropertyNamingStrategies. instead
(see
databind#2715
for reason for deprecation)
|
| Modifier and Type | Field and Description |
|---|---|
| public static final PropertyNamingStrategy | KEBAB_CASE
Deprecated
Since 2.12 deprecated.
|
| public static final PropertyNamingStrategy | LOWER_CAMEL_CASE
Deprecated
Since 2.12 deprecated.
|
| public static final PropertyNamingStrategy | LOWER_CASE
Deprecated
Since 2.12 deprecated.
|
| public static final PropertyNamingStrategy | LOWER_DOT_CASE
Deprecated
Since 2.12 deprecated.
|
| private static final long | |
| public static final PropertyNamingStrategy | SNAKE_CASE
Deprecated
Since 2.12 deprecated.
|
| public static final PropertyNamingStrategy | UPPER_CAMEL_CASE
Deprecated
Since 2.12 deprecated.
|
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public String | nameForConstructorParameter(MapperConfig<?>
Configuration in used: either config, AnnotatedParameter SerializationConfig
or DeserializationConfig, depending on whether method is called
during serialization or deserializationConstructor parameter used to pass property. ctorParam, String Default name that would be used for property in absence of custom strategy defaultName)Method called to find external name (name used in JSON) for given logical POJO property, as defined by given constructor parameter; typically called when building a deserializer (but not necessarily only then). |
| public String | Returns: Logical name to use for property that the field representsConfiguration in used: either config, AnnotatedField SerializationConfig
or DeserializationConfig, depending on whether method is called
during serialization or deserializationField used to access property field, String Default name that would be used for property in absence of custom strategy defaultName)Method called to find external name (name used in JSON) for given logical POJO property, as defined by given field. |
| public String | Returns: Logical name to use for property that the method representsConfiguration in used: either config, AnnotatedMethod SerializationConfig
or DeserializationConfig, depending on whether method is called
during serialization or deserializationMethod used to access property. method, String Default name that would be used for property in absence of custom strategy defaultName)Method called to find external name (name used in JSON) for given logical POJO property, as defined by given getter method; typically called when building a serializer. |
| public String | Returns: Logical name to use for property that the method representsConfiguration in used: either config, AnnotatedMethod SerializationConfig
or DeserializationConfig, depending on whether method is called
during serialization or deserializationMethod used to access property. method, String Default name that would be used for property in absence of custom strategy defaultName)Method called to find external name (name used in JSON) for given logical POJO property, as defined by given setter method; typically called when building a deserializer (but not necessarily only then). |
| KEBAB_CASE | back to summary |
|---|---|
| public static final PropertyNamingStrategy KEBAB_CASE
Deprecated Since 2.12 deprecated. Use | |
| LOWER_CAMEL_CASE | back to summary |
|---|---|
| public static final PropertyNamingStrategy LOWER_CAMEL_CASE
Deprecated Since 2.12 deprecated. Use | |
| LOWER_CASE | back to summary |
|---|---|
| public static final PropertyNamingStrategy LOWER_CASE
Deprecated Since 2.12 deprecated. Use | |
| LOWER_DOT_CASE | back to summary |
|---|---|
| public static final PropertyNamingStrategy LOWER_DOT_CASE
Deprecated Since 2.12 deprecated. Use | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| SNAKE_CASE | back to summary |
|---|---|
| public static final PropertyNamingStrategy SNAKE_CASE
Deprecated Since 2.12 deprecated. Use | |
| UPPER_CAMEL_CASE | back to summary |
|---|---|
| public static final PropertyNamingStrategy UPPER_CAMEL_CASE
Deprecated Since 2.12 deprecated. Use | |
| PropertyNamingStrategy | back to summary |
|---|---|
| public PropertyNamingStrategy() | |
| nameForConstructorParameter | back to summary |
|---|---|
| public String nameForConstructorParameter(MapperConfig<?> config, AnnotatedParameter ctorParam, String defaultName) Method called to find external name (name used in JSON) for given logical POJO property, as defined by given constructor parameter; typically called when building a deserializer (but not necessarily only then).
| |
| nameForField | back to summary |
|---|---|
| public String nameForField(MapperConfig<?> config, AnnotatedField field, String defaultName) Method called to find external name (name used in JSON) for given logical POJO property, as defined by given field.
| |
| nameForGetterMethod | back to summary |
|---|---|
| public String nameForGetterMethod(MapperConfig<?> config, AnnotatedMethod method, String defaultName) Method called to find external name (name used in JSON) for given logical POJO property, as defined by given getter method; typically called when building a serializer. (but not always -- when using "getter-as-setter", may be called during deserialization)
| |
| nameForSetterMethod | back to summary |
|---|---|
| public String nameForSetterMethod(MapperConfig<?> config, AnnotatedMethod method, String defaultName) Method called to find external name (name used in JSON) for given logical POJO property, as defined by given setter method; typically called when building a deserializer (but not necessarily only then).
| |
Deprecated
Since 2.12 use PropertyNamingStrategies. instead
(see
databind#2715
for reason for deprecation)
| Access | Constructor and Description |
|---|---|
| public | |
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public String | translate(String input)
Implements abstract com.
|
| KebabCaseStrategy | back to summary |
|---|---|
| public KebabCaseStrategy() | |
| KebabCaseStrategy | back to summary |
|---|---|
| protected KebabCaseStrategy(boolean logWarning) | |
| translate | back to summary |
|---|---|
| public String translate(String input) Implements abstract com.
| |
Deprecated
Since 2.12 use PropertyNamingStrategies. instead
(see
databind#2715
for reason for deprecation)
| Access | Constructor and Description |
|---|---|
| public | |
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public String | translate(String input)
Implements abstract com.
|
| LowerCaseStrategy | back to summary |
|---|---|
| public LowerCaseStrategy() | |
| LowerCaseStrategy | back to summary |
|---|---|
| protected LowerCaseStrategy(boolean logWarning) | |
| translate | back to summary |
|---|---|
| public String translate(String input) Implements abstract com.
| |
Deprecated
Since 2.12 use PropertyNamingStrategies. instead
(see
databind#2715
for reason for deprecation)
| Access | Constructor and Description |
|---|---|
| public | |
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public String | translate(String input)
Implements abstract com.
|
| LowerDotCaseStrategy | back to summary |
|---|---|
| public LowerDotCaseStrategy() | |
| LowerDotCaseStrategy | back to summary |
|---|---|
| protected LowerDotCaseStrategy(boolean logWarning) | |
| translate | back to summary |
|---|---|
| public String translate(String input) Implements abstract com.
| |
Deprecated
Since 2.12 deprecated. See databind#2715 for reasons for deprecation.
| Access | Constructor and Description |
|---|---|
| protected | |
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public String | nameForConstructorParameter(MapperConfig<?>
Configuration in used: either config, AnnotatedParameter SerializationConfig
or DeserializationConfig, depending on whether method is called
during serialization or deserializationConstructor parameter used to pass property. ctorParam, String Default name that would be used for property in absence of custom strategy defaultName)Overrides com. Method called to find external name (name used in JSON) for given logical POJO property, as defined by given constructor parameter; typically called when building a deserializer (but not necessarily only then). |
| public String | nameForField(MapperConfig<?>
Configuration in used: either config, AnnotatedField SerializationConfig
or DeserializationConfig, depending on whether method is called
during serialization or deserializationField used to access property field, String Default name that would be used for property in absence of custom strategy defaultName)Overrides com. Method called to find external name (name used in JSON) for given logical POJO property, as defined by given field. |
| public String | nameForGetterMethod(MapperConfig<?>
Configuration in used: either config, AnnotatedMethod SerializationConfig
or DeserializationConfig, depending on whether method is called
during serialization or deserializationMethod used to access property. method, String Default name that would be used for property in absence of custom strategy defaultName)Overrides com. Method called to find external name (name used in JSON) for given logical POJO property, as defined by given getter method; typically called when building a serializer. |
| public String | nameForSetterMethod(MapperConfig<?>
Configuration in used: either config, AnnotatedMethod SerializationConfig
or DeserializationConfig, depending on whether method is called
during serialization or deserializationMethod used to access property. method, String Default name that would be used for property in absence of custom strategy defaultName)Overrides com. Method called to find external name (name used in JSON) for given logical POJO property, as defined by given setter method; typically called when building a deserializer (but not necessarily only then). |
| public abstract String | |
| protected static String | translateLowerCaseWithSeparator(final String input, final char separator)
Helper method to share implementation between snake and dotted case. |
| PropertyNamingStrategyBase | back to summary |
|---|---|
| protected PropertyNamingStrategyBase() | |
| PropertyNamingStrategyBase | back to summary |
|---|---|
| protected PropertyNamingStrategyBase(boolean logWarning) | |
| nameForConstructorParameter | back to summary |
|---|---|
| public String nameForConstructorParameter(MapperConfig<?> config, AnnotatedParameter ctorParam, String defaultName) Overrides com. Doc from com. Method called to find external name (name used in JSON) for given logical POJO property, as defined by given constructor parameter; typically called when building a deserializer (but not necessarily only then).
| |
| nameForField | back to summary |
|---|---|
| public String nameForField(MapperConfig<?> config, AnnotatedField field, String defaultName) Overrides com. Doc from com. Method called to find external name (name used in JSON) for given logical POJO property, as defined by given field.
| |
| nameForGetterMethod | back to summary |
|---|---|
| public String nameForGetterMethod(MapperConfig<?> config, AnnotatedMethod method, String defaultName) Overrides com. Doc from com. Method called to find external name (name used in JSON) for given logical POJO property, as defined by given getter method; typically called when building a serializer. (but not always -- when using "getter-as-setter", may be called during deserialization)
| |
| nameForSetterMethod | back to summary |
|---|---|
| public String nameForSetterMethod(MapperConfig<?> config, AnnotatedMethod method, String defaultName) Overrides com. Doc from com. Method called to find external name (name used in JSON) for given logical POJO property, as defined by given setter method; typically called when building a deserializer (but not necessarily only then).
| |
| translate | back to summary |
|---|---|
| public abstract String translate(String propertyName) | |
| translateLowerCaseWithSeparator | back to summary |
|---|---|
| protected static String translateLowerCaseWithSeparator(final String input, final char separator) Helper method to share implementation between snake and dotted case. | |
Deprecated
Since 2.12 use PropertyNamingStrategies. instead
(see
databind#2715
for reason for deprecation)
| Access | Constructor and Description |
|---|---|
| public | |
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public String | translate(String input)
Implements abstract com.
|
| SnakeCaseStrategy | back to summary |
|---|---|
| public SnakeCaseStrategy() | |
| SnakeCaseStrategy | back to summary |
|---|---|
| protected SnakeCaseStrategy(boolean logWarning) | |
| translate | back to summary |
|---|---|
| public String translate(String input) Implements abstract com.
| |
Deprecated
Since 2.12 use PropertyNamingStrategies. instead
(see
databind#2715
for reason for deprecation)
| Access | Constructor and Description |
|---|---|
| public | |
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public String | Returns: input converted to PascalCase formatformatted as camelCase string input)Implements abstract com. Converts camelCase to PascalCase For example, "userName" would be converted to "UserName". |
| UpperCamelCaseStrategy | back to summary |
|---|---|
| public UpperCamelCaseStrategy() | |
| UpperCamelCaseStrategy | back to summary |
|---|---|
| protected UpperCamelCaseStrategy(boolean logWarning) | |
| translate | back to summary |
|---|---|
| public String translate(String input) Implements abstract com. Converts camelCase to PascalCase For example, "userName" would be converted to "UserName". | |