-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b735280
commit 9f97baa
Showing
2 changed files
with
356 additions
and
47 deletions.
There are no files selected for viewing
330 changes: 330 additions & 0 deletions
330
src/main/java/com/fasterxml/jackson/databind/PropertyNamingStrategies.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,330 @@ | ||
| package com.fasterxml.jackson.databind; | ||
|
|
||
| import com.fasterxml.jackson.databind.cfg.MapperConfig; | ||
| import com.fasterxml.jackson.databind.introspect.AnnotatedField; | ||
| import com.fasterxml.jackson.databind.introspect.AnnotatedMethod; | ||
| import com.fasterxml.jackson.databind.introspect.AnnotatedParameter; | ||
|
|
||
| /** | ||
| * Container for standard {@link PropertyNamingStrategy} implementations | ||
| * and singleton instances. | ||
| *<p> | ||
| * Added in Jackson 2.12 to resolve issue | ||
| * <a href="https://github.com/FasterXML/jackson-databind/issues/2715">databind#2715</a>. | ||
| * | ||
| * @since 2.12 | ||
| */ | ||
| public abstract class PropertyNamingStrategies | ||
| implements java.io.Serializable | ||
| { | ||
| private static final long serialVersionUID = 2L; | ||
|
|
||
| /* | ||
| /********************************************************************** | ||
| /* Static instances that may be referenced | ||
| /********************************************************************** | ||
| */ | ||
|
|
||
| /** | ||
| * Naming convention used in Java, where words other than first are capitalized | ||
| * and no separator is used between words. Since this is the native Java naming convention, | ||
| * naming strategy will not do any transformation between names in data (JSON) and | ||
| * POJOS. | ||
| */ | ||
| public static final PropertyNamingStrategy LOWER_CAMEL_CASE = new PropertyNamingStrategy(); | ||
|
|
||
| /** | ||
| * Naming convention used in languages like Pascal, where words are capitalized | ||
| * and no separator is used between words. | ||
| * See {@link UpperCamelCaseStrategy} for details. | ||
| */ | ||
| public static final PropertyNamingStrategy UPPER_CAMEL_CASE = new UpperCamelCaseStrategy(); | ||
|
|
||
| /** | ||
| * Naming convention used in languages like C, where words are in lower-case | ||
| * letters, separated by underscores. | ||
| * See {@link SnakeCaseStrategy} for details. | ||
| */ | ||
| public static final PropertyNamingStrategy SNAKE_CASE = new SnakeCaseStrategy(); | ||
|
|
||
| /** | ||
| * Naming convention in which all words of the logical name are in lower case, and | ||
| * no separator is used between words. | ||
| * See {@link LowerCaseStrategy} for details. | ||
| */ | ||
| public static final PropertyNamingStrategy LOWER_CASE = new LowerCaseStrategy(); | ||
|
|
||
| /** | ||
| * Naming convention used in languages like Lisp, where words are in lower-case | ||
| * letters, separated by hyphens. | ||
| * See {@link KebabCaseStrategy} for details. | ||
| */ | ||
| public static final PropertyNamingStrategy KEBAB_CASE = new KebabCaseStrategy(); | ||
|
|
||
| /** | ||
| * Naming convention widely used as configuration properties name, where words are in | ||
| * lower-case letters, separated by dots. | ||
| * See {@link LowerDotCaseStrategy} for details. | ||
| */ | ||
| public static final PropertyNamingStrategy LOWER_DOT_CASE = new LowerDotCaseStrategy(); | ||
|
|
||
| /* | ||
| /********************************************************************** | ||
| /* Public base class for simple implementations | ||
| /********************************************************************** | ||
| */ | ||
|
|
||
| /** | ||
| * Intermediate base class for simple implementations | ||
| */ | ||
| static abstract class NamingBase | ||
| extends PropertyNamingStrategy | ||
| { | ||
| private static final long serialVersionUID = 2L; | ||
|
|
||
| @Override | ||
| public String nameForField(MapperConfig<?> config, AnnotatedField field, String defaultName) { | ||
| return translate(defaultName); | ||
| } | ||
|
|
||
| @Override | ||
| public String nameForGetterMethod(MapperConfig<?> config, AnnotatedMethod method, String defaultName) { | ||
| return translate(defaultName); | ||
| } | ||
|
|
||
| @Override | ||
| public String nameForSetterMethod(MapperConfig<?> config, AnnotatedMethod method, String defaultName) { | ||
| return translate(defaultName); | ||
| } | ||
|
|
||
| @Override | ||
| public String nameForConstructorParameter(MapperConfig<?> config, AnnotatedParameter ctorParam, | ||
| String defaultName) { | ||
| return translate(defaultName); | ||
| } | ||
|
|
||
| public abstract String translate(String propertyName); | ||
|
|
||
| /** | ||
| * Helper method to share implementation between snake and dotted case. | ||
| */ | ||
| protected String translateLowerCaseWithSeparator(final String input, final char separator) | ||
| { | ||
| if (input == null) { | ||
| return input; // garbage in, garbage out | ||
| } | ||
| final int length = input.length(); | ||
| if (length == 0) { | ||
| return input; | ||
| } | ||
|
|
||
| final StringBuilder result = new StringBuilder(length + (length >> 1)); | ||
| int upperCount = 0; | ||
| for (int i = 0; i < length; ++i) { | ||
| char ch = input.charAt(i); | ||
| char lc = Character.toLowerCase(ch); | ||
|
|
||
| if (lc == ch) { // lower-case letter means we can get new word | ||
| // but need to check for multi-letter upper-case (acronym), where assumption | ||
| // is that the last upper-case char is start of a new word | ||
| if (upperCount > 1) { | ||
| // so insert hyphen before the last character now | ||
| result.insert(result.length() - 1, separator); | ||
| } | ||
| upperCount = 0; | ||
| } else { | ||
| // Otherwise starts new word, unless beginning of string | ||
| if ((upperCount == 0) && (i > 0)) { | ||
| result.append(separator); | ||
| } | ||
| ++upperCount; | ||
| } | ||
| result.append(lc); | ||
| } | ||
| return result.toString(); | ||
| } | ||
| } | ||
|
|
||
| /* | ||
| /********************************************************************** | ||
| /* Standard implementations | ||
| /********************************************************************** | ||
| */ | ||
|
|
||
| /** | ||
| * A {@link PropertyNamingStrategy} that translates typical camel case Java | ||
| * property names to lower case JSON element names, separated by | ||
| * underscores. This implementation is somewhat lenient, in that it | ||
| * provides some additional translations beyond strictly translating from | ||
| * camel case only. In particular, the following translations are applied | ||
| * by this PropertyNamingStrategy. | ||
| * | ||
| * <ul><li>Every upper case letter in the Java property name is translated | ||
| * into two characters, an underscore and the lower case equivalent of the | ||
| * target character, with three exceptions. | ||
| * <ol><li>For contiguous sequences of upper case letters, characters after | ||
| * the first character are replaced only by their lower case equivalent, | ||
| * and are not preceded by an underscore. | ||
| * <ul><li>This provides for reasonable translations of upper case acronyms, | ||
| * e.g., "theWWW" is translated to "the_www".</li></ul></li> | ||
| * <li>An upper case character in the first position of the Java property | ||
| * name is not preceded by an underscore character, and is translated only | ||
| * to its lower case equivalent. | ||
| * <ul><li>For example, "Results" is translated to "results", | ||
| * and not to "_results".</li></ul></li> | ||
| * <li>An upper case character in the Java property name that is already | ||
| * preceded by an underscore character is translated only to its lower case | ||
| * equivalent, and is not preceded by an additional underscore. | ||
| * <ul><li>For example, "user_Name" is translated to | ||
| * "user_name", and not to "user__name" (with two | ||
| * underscore characters).</li></ul></li></ol></li> | ||
| * <li>If the Java property name starts with an underscore, then that | ||
| * underscore is not included in the translated name, unless the Java | ||
| * property name is just one character in length, i.e., it is the | ||
| * underscore character. This applies only to the first character of the | ||
| * Java property name.</li></ul> | ||
| * | ||
| * These rules result in the following additional example translations from | ||
| * Java property names to JSON element names. | ||
| * <ul><li>"userName" is translated to "user_name"</li> | ||
| * <li>"UserName" is translated to "user_name"</li> | ||
| * <li>"USER_NAME" is translated to "user_name"</li> | ||
| * <li>"user_name" is translated to "user_name" (unchanged)</li> | ||
| * <li>"user" is translated to "user" (unchanged)</li> | ||
| * <li>"User" is translated to "user"</li> | ||
| * <li>"USER" is translated to "user"</li> | ||
| * <li>"_user" is translated to "user"</li> | ||
| * <li>"_User" is translated to "user"</li> | ||
| * <li>"__user" is translated to "_user" | ||
| * (the first of two underscores was removed)</li> | ||
| * <li>"user__name" is translated to "user__name" | ||
| * (unchanged, with two underscores)</li></ul> | ||
| */ | ||
| public static class SnakeCaseStrategy extends NamingBase | ||
| { | ||
| private static final long serialVersionUID = 2L; | ||
|
|
||
| @Override | ||
| public String translate(String input) | ||
| { | ||
| if (input == null) return input; // garbage in, garbage out | ||
| int length = input.length(); | ||
| StringBuilder result = new StringBuilder(length * 2); | ||
| int resultLength = 0; | ||
| boolean wasPrevTranslated = false; | ||
| for (int i = 0; i < length; i++) | ||
| { | ||
| char c = input.charAt(i); | ||
| if (i > 0 || c != '_') // skip first starting underscore | ||
| { | ||
| if (Character.isUpperCase(c)) | ||
| { | ||
| if (!wasPrevTranslated && resultLength > 0 && result.charAt(resultLength - 1) != '_') | ||
| { | ||
| result.append('_'); | ||
| resultLength++; | ||
| } | ||
| c = Character.toLowerCase(c); | ||
| wasPrevTranslated = true; | ||
| } | ||
| else | ||
| { | ||
| wasPrevTranslated = false; | ||
| } | ||
| result.append(c); | ||
| resultLength++; | ||
| } | ||
| } | ||
| return resultLength > 0 ? result.toString() : input; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * A {@link PropertyNamingStrategy} that translates typical camelCase Java | ||
| * property names to PascalCase JSON element names (i.e., with a capital | ||
| * first letter). In particular, the following translations are applied by | ||
| * this PropertyNamingStrategy. | ||
| * | ||
| * <ul><li>The first lower-case letter in the Java property name is translated | ||
| * into its equivalent upper-case representation.</li></ul> | ||
| * | ||
| * This rules result in the following example translation from | ||
| * Java property names to JSON element names. | ||
| * <ul><li>"userName" is translated to "UserName"</li></ul> | ||
| */ | ||
| public static class UpperCamelCaseStrategy extends NamingBase | ||
| { | ||
| private static final long serialVersionUID = 2L; | ||
|
|
||
| /** | ||
| * Converts camelCase to PascalCase | ||
| * | ||
| * For example, "userName" would be converted to | ||
| * "UserName". | ||
| * | ||
| * @param input formatted as camelCase string | ||
| * @return input converted to PascalCase format | ||
| */ | ||
| @Override | ||
| public String translate(String input) { | ||
| if (input == null || input.length() == 0){ | ||
| return input; // garbage in, garbage out | ||
| } | ||
| // Replace first lower-case letter with upper-case equivalent | ||
| char c = input.charAt(0); | ||
| char uc = Character.toUpperCase(c); | ||
| if (c == uc) { | ||
| return input; | ||
| } | ||
| StringBuilder sb = new StringBuilder(input); | ||
| sb.setCharAt(0, uc); | ||
| return sb.toString(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Simple strategy where external name simply only uses lower-case characters, | ||
| * and no separators. | ||
| * Conversion from internal name like "someOtherValue" would be into external name | ||
| * if "someothervalue". | ||
| */ | ||
| public static class LowerCaseStrategy extends NamingBase | ||
| { | ||
| private static final long serialVersionUID = 2L; | ||
|
|
||
| @Override | ||
| public String translate(String input) { | ||
| return input.toLowerCase(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Naming strategy similar to {@link PropertyNamingStrategies.SnakeCaseStrategy}, | ||
| * but instead of underscores | ||
| * as separators, uses hyphens. Naming convention traditionally used for languages | ||
| * like Lisp. | ||
| */ | ||
| public static class KebabCaseStrategy extends NamingBase | ||
| { | ||
| private static final long serialVersionUID = 2L; | ||
|
|
||
| @Override | ||
| public String translate(String input) { | ||
| return translateLowerCaseWithSeparator(input, '-'); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Naming strategy similar to {@link PropertyNamingStrategies.KebabCaseStrategy}, | ||
| * but instead of hyphens | ||
| * as separators, uses dots. Naming convention widely used as configuration properties name. | ||
| */ | ||
| public static class LowerDotCaseStrategy extends NamingBase { | ||
| private static final long serialVersionUID = 2L; | ||
|
|
||
| @Override | ||
| public String translate(String input){ | ||
| return translateLowerCaseWithSeparator(input, '.'); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.