org.opendaylight.mdsal.binding.javav2.generator.util

Class JavaIdentifierNormalizer

java.lang.Object

org.opendaylight.mdsal.binding.javav2.generator.util.JavaIdentifierNormalizer

@Beta
public final class JavaIdentifierNormalizer
extends Object

This util class converts every non-java char in identifier to java char by its unicode name (JAVA SE SPECIFICATIONS - Identifiers). There are special types of mapping non-java chars to original identifiers according to specific java type:

• class, enum, interface
• • without special separator
  • the first character of identifier, any other first character of identifier part mapped by non-Java char name from unicode and char in identifier behind non-java char name are converting to upper case
  • examples:
  • • example* - ExampleAsterisk
    • example*example - ExampleAserisksExample
    • \example - ReverseSolidusExample
    • 1example - DigitOneExample
    • example1 - Example1
    • int - IntReservedKeyword
    • con - ConReservedKeyword
• enum value, constant
• • used underscore as special separator
  • converted identifier to upper case
  • examples:
  • • example* - EXAMPLE_ASTERISK
    • example*example - EXAMPLE_ASTERISK_EXAMPLE
    • \example - REVERSE_SOLIDUS_EXAMPLE
    • 1example - DIGIT_ONE_EXAMPLE
    • example1 - EXAMPLE1
    • int - INT_RESERVED_KEYWORD
    • con - CON_RESERVED_KEYWORD
• method, variable
• • without special separator
  • the first character of identifier is converting to lower case
  • any other first character of identifier part mapped by non-Java char name from unicode and char in identifier behind non-java char name are converting to upper case
  • examples:
  • • example* - exampleAsterisk
    • example*example - exampleAserisksExample
    • \example - reverseSolidusExample
    • 1example - digitOneExample
    • example1 - example1
    • int - intReservedKeyword
    • con - conReservedKeyword
• package - full package name ( Naming a package)
• • parts of package name are separated by dots
  • parts of package name are converting to lower case
  • if parts of package name are reserved Java or Windows keywords, such as 'int' the suggested convention is to add an underscore to keyword
  • dash is parsed as underscore according to Naming a package
  • examples:
  • • org.example* - org.exampleasterisk
    • org.example*example - org.exampleasteriskexample
    • org.\example - org.reversesolidusexample
    • org.1example - org.digitoneexample
    • org.example1 - org.example1
    • org.int - org.int_
    • org.con - org.con_
    • org.foo-cont - org.foo_cont

There is special case in CLASS, INTERFACE, ENUM, ENUM VALUE, CONSTANT, METHOD and VARIABLE if identifier contains single dash - then the converter ignores the single dash in the way of the non-java chars. In other way, if dash is the first or the last char in the identifier or there is more dashes in a row in the identifier, then these dashes are converted as non-java chars. Example:

• class, enum, interface
• • foo-cont - FooCont
  • foo--cont - FooHyphenMinusHyphenMinusCont
  • -foo - HyphenMinusFoo
  • foo- - FooHyphenMinus
• enum value, constant
• • foo-cont - FOO_CONT
  • foo--cont - FOO_HYPHEN_MINUS_HYPHEN_MINUS_CONT
  • -foo - HYPHEN_MINUS_FOO
  • foo- - FOO_HYPHEN_MINUS
• method, variable
• • foo-cont - fooCont
  • foo--cont - fooHyphenMinusHyphenMinusCont
  • -foo - hyphenMinusFoo
  • foo- - fooHyphenMinus

Next special case talks about normalizing class name which already exists in package - but with different camel cases (foo, Foo, fOo, ...). To every next classes with same names will by added their actual rank (serial number), except the first one. This working for CLASS, ENUM and INTEFACE java identifiers. If there exist the same ENUM VALUES in ENUM (with different camel cases), then it's parsed with same logic like CLASSES, ENUMS and INTERFACES but according to list of pairs of their ENUM parent. Example:

• class, enum, interface
• • package name org.example, class (or interface or enum) Foo - normalized to Foo
  • package name org.example, class (or interface or enum) fOo - normalized to Foo1
• enum value

• •  type enumeration {
         enum foo;
         enum Foo;
     }
     

  • YANG enum values will be mapped to 'FOO' and 'FOO_1' Java enum values.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	SPECIAL_RESERVED_PATHS

Method Summary

Modifier and Type	Method and Description
static String	normalizeEnumValueIdentifier(String name, List<Enumeration.Pair> values) According to YANG RFC 7950, all assigned names in an enumeration MUST be unique.
static String	normalizeFullPackageName(String fullPackageName) Normalizing full package name by non java chars and reserved keywords.
static String	normalizeSpecificIdentifier(String identifier, JavaIdentifier javaIdentifier) Find and convert non Java chars in identifiers of generated transfer objects, initially derived from corresponding YANG.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SPECIAL_RESERVED_PATHS

public static final Set<String> SPECIAL_RESERVED_PATHS

Method Detail

normalizeEnumValueIdentifier

public static String normalizeEnumValueIdentifier(String name,
                                                  List<Enumeration.Pair> values)

According to YANG RFC 7950, all assigned names in an enumeration MUST be unique. Created names are contained in the list of Enumeration.Pair. This method adds actual index with underscore behind name of new enum value only if this name already exists in one of the list of Enumeration.Pair. Then, the name will be converted to java chars according to JavaIdentifier.ENUM_VALUE and returned.

Example:

 type enumeration {
     enum foo;
     enum Foo;
 }
 

YANG enum values will be mapped to 'FOO' and 'FOO_1' Java enum values.

Parameters:

name - - name of new enum value

values - - list of all actual enum values

Returns:

converted and fixed name of new enum value

normalizeFullPackageName

public static String normalizeFullPackageName(String fullPackageName)

Normalizing full package name by non java chars and reserved keywords.

Parameters:

fullPackageName - - full package name

Returns:

normalized name

normalizeSpecificIdentifier

public static String normalizeSpecificIdentifier(String identifier,
                                                 JavaIdentifier javaIdentifier)

Find and convert non Java chars in identifiers of generated transfer objects, initially derived from corresponding YANG.

Parameters:

identifier - - name of identifier

javaIdentifier - - java type of identifier

Returns:

- java acceptable identifier