public abstract class PropertyNamingStrategy extends Object
Default implementation returns suggested ("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.
In absence of a registered custom strategy, 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).
Modifier and Type | Class and Description |
---|---|
static class |
PropertyNamingStrategy.LowerCaseWithUnderscoresStrategy
A
PropertyNamingStrategy that translates typical camel case Java
property names to lower case JSON element names, separated by
underscores. |
static class |
PropertyNamingStrategy.PropertyNamingStrategyBase |
Modifier and Type | Field and Description |
---|---|
static PropertyNamingStrategy |
CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES
See
PropertyNamingStrategy.LowerCaseWithUnderscoresStrategy for details. |
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).
|
public static final PropertyNamingStrategy CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES
PropertyNamingStrategy.LowerCaseWithUnderscoresStrategy
for details.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 strategy