public class PropertyNamingStrategy extends Object implements Serializable
Default (empty) 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.KebabCaseStrategy
Naming strategy similar to
PropertyNamingStrategy.SnakeCaseStrategy , but instead of underscores
as separators, uses hyphens. |
static class |
PropertyNamingStrategy.LowerCaseStrategy
Simple strategy where external name simply only uses lower-case characters,
and no separators.
|
static class |
PropertyNamingStrategy.LowerCaseWithUnderscoresStrategy
Deprecated.
In 2.7 use
PropertyNamingStrategy.SnakeCaseStrategy instead |
static class |
PropertyNamingStrategy.PascalCaseStrategy
Deprecated.
In 2.7 use
PropertyNamingStrategy.UpperCamelCaseStrategy instead |
static class |
PropertyNamingStrategy.PropertyNamingStrategyBase |
static class |
PropertyNamingStrategy.SnakeCaseStrategy
A
PropertyNamingStrategy that translates typical camel case Java
property names to lower case JSON element names, separated by
underscores. |
static class |
PropertyNamingStrategy.UpperCamelCaseStrategy
A
PropertyNamingStrategy that translates typical camelCase Java
property names to PascalCase JSON element names (i.e., with a capital
first letter). |
Modifier and Type | Field and Description |
---|---|
static PropertyNamingStrategy |
CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES
Deprecated.
Since 2.7 use
SNAKE_CASE instead; |
static PropertyNamingStrategy |
KEBAB_CASE
Naming convention used in languages like Lisp, where words are in lower-case
letters, separated by hyphens.
|
static PropertyNamingStrategy |
LOWER_CAMEL_CASE
Naming convention used in Java, where words other than first are capitalized
and no separator is used between words.
|
static PropertyNamingStrategy |
LOWER_CASE
Naming convention in which all words of the logical name are in lower case, and
no separator is used between words.
|
static PropertyNamingStrategy |
PASCAL_CASE_TO_CAMEL_CASE
Deprecated.
Since 2.7 use
UPPER_CAMEL_CASE instead; |
static PropertyNamingStrategy |
SNAKE_CASE
Naming convention used in languages like C, where words are in lower-case
letters, separated by underscores.
|
static PropertyNamingStrategy |
UPPER_CAMEL_CASE
Naming convention used in languages like Pascal, where words are capitalized
and no separator is used between words.
|
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 SNAKE_CASE
PropertyNamingStrategy.SnakeCaseStrategy
for details.CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES
)public static final PropertyNamingStrategy UPPER_CAMEL_CASE
PropertyNamingStrategy.PascalCaseStrategy
for details.PASCAL_CASE_TO_CAMEL_CASE
)public static final PropertyNamingStrategy LOWER_CAMEL_CASE
PASCAL_CASE_TO_CAMEL_CASE
)public static final PropertyNamingStrategy LOWER_CASE
PropertyNamingStrategy.LowerCaseStrategy
for details.public static final PropertyNamingStrategy KEBAB_CASE
PropertyNamingStrategy.KebabCaseStrategy
for details.@Deprecated public static final PropertyNamingStrategy CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES
SNAKE_CASE
instead;@Deprecated public static final PropertyNamingStrategy PASCAL_CASE_TO_CAMEL_CASE
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 © 2018 JBoss by Red Hat. All rights reserved.