Package org.codehaus.jackson.map
Class PropertyNamingStrategy
- java.lang.Object
-
- org.codehaus.jackson.map.PropertyNamingStrategy
-
- Direct Known Subclasses:
PropertyNamingStrategy.PropertyNamingStrategyBase
public abstract class PropertyNamingStrategy extends java.lang.Object
Class that defines how names of JSON properties ("external names") are derived from names of POJO methods and fields ("internal names"), in cases where they are not auto-detected and no explicit annotations exist for naming. Methods are passed information about POJO member for which name is needed, as well as default name that would be used if no custom strategy was used.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).
- Since:
- 1.8
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PropertyNamingStrategy.LowerCaseWithUnderscoresStrategy
APropertyNamingStrategy
that translates typical camel case Java property names to lower case JSON element names, separated by underscores.static class
PropertyNamingStrategy.PropertyNamingStrategyBase
-
Field Summary
Fields Modifier and Type Field Description static PropertyNamingStrategy
CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES
SeePropertyNamingStrategy.LowerCaseWithUnderscoresStrategy
for details.
-
Constructor Summary
Constructors Constructor Description PropertyNamingStrategy()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
nameForConstructorParameter(MapperConfig<?> config, AnnotatedParameter ctorParam, java.lang.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).java.lang.String
nameForField(MapperConfig<?> config, AnnotatedField field, java.lang.String defaultName)
Method called to find external name (name used in JSON) for given logical POJO property, as defined by given field.java.lang.String
nameForGetterMethod(MapperConfig<?> config, AnnotatedMethod method, java.lang.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.java.lang.String
nameForSetterMethod(MapperConfig<?> config, AnnotatedMethod method, java.lang.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).
-
-
-
Field Detail
-
CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES
public static final PropertyNamingStrategy CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES
SeePropertyNamingStrategy.LowerCaseWithUnderscoresStrategy
for details.- Since:
- 1.9
-
-
Method Detail
-
nameForField
public java.lang.String nameForField(MapperConfig<?> config, AnnotatedField field, java.lang.String defaultName)
Method called to find external name (name used in JSON) for given logical POJO property, as defined by given field.- Parameters:
config
- Configuration in used: eitherSerializationConfig
orDeserializationConfig
, 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 strategy- Returns:
- Logical name to use for property that the field represents
-
nameForGetterMethod
public java.lang.String nameForGetterMethod(MapperConfig<?> config, AnnotatedMethod method, java.lang.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)- Parameters:
config
- Configuration in used: eitherSerializationConfig
orDeserializationConfig
, 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 strategy- Returns:
- Logical name to use for property that the method represents
-
nameForSetterMethod
public java.lang.String nameForSetterMethod(MapperConfig<?> config, AnnotatedMethod method, java.lang.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).- Parameters:
config
- Configuration in used: eitherSerializationConfig
orDeserializationConfig
, 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 strategy- Returns:
- Logical name to use for property that the method represents
-
nameForConstructorParameter
public java.lang.String nameForConstructorParameter(MapperConfig<?> config, AnnotatedParameter ctorParam, java.lang.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).- Parameters:
config
- Configuration in used: eitherSerializationConfig
orDeserializationConfig
, 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- Since:
- 1.9
-
-