public class PropertyNamingStrategy extends Object implements Serializable
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.
Constructor and Description |
---|
PropertyNamingStrategy() |
Modifier and Type | Method and Description |
---|---|
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).
|
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.
|
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.
|
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 public static final PropertyNamingStrategy LOWER_CAMEL_CASE
PropertyNamingStrategies.LOWER_CAMEL_CASE
instead.
See
databind#2715
for reasons for deprecation.@Deprecated public static final PropertyNamingStrategy UPPER_CAMEL_CASE
PropertyNamingStrategies.UPPER_CAMEL_CASE
instead.
See
databind#2715
for reasons for deprecation.@Deprecated public static final PropertyNamingStrategy SNAKE_CASE
PropertyNamingStrategies.SNAKE_CASE
instead.
See
databind#2715
for reasons for deprecation.@Deprecated public static final PropertyNamingStrategy LOWER_CASE
PropertyNamingStrategies.LOWER_CASE
instead.
See
databind#2715
for reasons for deprecation.@Deprecated public static final PropertyNamingStrategy KEBAB_CASE
PropertyNamingStrategies.KEBAB_CASE
instead.
See
databind#2715
for reasons for deprecation.@Deprecated public static final PropertyNamingStrategy LOWER_DOT_CASE
PropertyNamingStrategies.LOWER_DOT_CASE
instead.
See
databind#2715
for reasons for deprecation.@Deprecated public static final PropertyNamingStrategy CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES
PropertyNamingStrategies.SNAKE_CASE
instead.@Deprecated public static final PropertyNamingStrategy PASCAL_CASE_TO_CAMEL_CASE
PropertyNamingStrategies.UPPER_CAMEL_CASE
instead;public String nameForField(MapperConfig<?> config, AnnotatedField field, String defaultName)
config
- Configuration in used: either SerializationConfig
or DeserializationConfig
, depending on whether method is called
during serialization or deserializationfield
- Field used to access propertydefaultName
- Default name that would be used for property in absence of custom strategypublic String nameForGetterMethod(MapperConfig<?> config, AnnotatedMethod method, String defaultName)
config
- Configuration in used: either SerializationConfig
or DeserializationConfig
, depending on whether method is called
during serialization or deserializationmethod
- Method used to access property.defaultName
- Default name that would be used for property in absence of custom strategypublic String nameForSetterMethod(MapperConfig<?> config, AnnotatedMethod method, String defaultName)
config
- Configuration in used: either SerializationConfig
or DeserializationConfig
, depending on whether method is called
during serialization or deserializationmethod
- Method used to access property.defaultName
- Default name that would be used for property in absence of custom strategypublic String nameForConstructorParameter(MapperConfig<?> config, AnnotatedParameter ctorParam, String defaultName)
config
- Configuration in used: either SerializationConfig
or DeserializationConfig
, depending on whether method is called
during serialization or deserializationctorParam
- Constructor parameter used to pass property.defaultName
- Default name that would be used for property in absence of custom strategyCopyright © 2021 JBoss by Red Hat. All rights reserved.