JavaIdentifierNormalizer ThreadSafe/Memory leak fix
[mdsal.git] / binding2 / mdsal-binding2-generator-util / src / main / java / org / opendaylight / mdsal / binding / javav2 / generator / util / JavaIdentifierNormalizer.java
index 6dae4f32f30d76d39a2163bfb732f841d8aec4c0..b2cc55207aafde6a3e07e6d6863d1ce07ef1f449 100644 (file)
@@ -10,12 +10,13 @@ package org.opendaylight.mdsal.binding.javav2.generator.util;
 import com.google.common.annotations.Beta;
 import com.google.common.base.CharMatcher;
 import com.google.common.base.Splitter;
-import com.google.common.collect.ArrayListMultimap;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.ListMultimap;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Set;
+import java.util.stream.Collectors;
+import org.opendaylight.mdsal.binding.javav2.generator.context.ModuleContext;
 import org.opendaylight.mdsal.binding.javav2.model.api.Enumeration;
 import org.opendaylight.mdsal.binding.javav2.model.api.Enumeration.Pair;
 import org.opendaylight.mdsal.binding.javav2.util.BindingMapping;
@@ -205,12 +206,9 @@ public final class JavaIdentifierNormalizer {
         "java",
         "com");
 
-    private static final int FIRST_CHAR = 0;
-    private static final int FIRST_INDEX = 1;
     private static final char UNDERSCORE = '_';
     private static final char DASH = '-';
     private static final String RESERVED_KEYWORD = "reserved_keyword";
-    private static final ListMultimap<String, String> PACKAGES_MAP = ArrayListMultimap.create();
     private static final Set<String> PRIMITIVE_TYPES = ImmutableSet.of("char[]", "byte[]");
 
     private static final CharMatcher DASH_MATCHER = CharMatcher.is(DASH);
@@ -219,6 +217,10 @@ public final class JavaIdentifierNormalizer {
     private static final Splitter DOT_SPLITTER = Splitter.on('.');
     private static final Splitter UNDERSCORE_SPLITTER = Splitter.on(UNDERSCORE);
 
+    // Converted to lower case
+    private static final Set<String> WINDOWS_RESERVED_WORDS = BindingMapping.WINDOWS_RESERVED_WORDS.stream()
+            .map(String::toLowerCase).collect(Collectors.collectingAndThen(Collectors.toSet(), ImmutableSet::copyOf));
+
     private JavaIdentifierNormalizer() {
         throw new UnsupportedOperationException("Util class");
     }
@@ -250,7 +252,7 @@ public final class JavaIdentifierNormalizer {
      * @return converted and fixed name of new enum value
      */
     public static String normalizeEnumValueIdentifier(final String name, final List<Pair> values) {
-        return convertIdentifierEnumValue(name, name, values, FIRST_INDEX);
+        return convertIdentifierEnumValue(name, name, values, 1);
     }
 
     /**
@@ -283,12 +285,11 @@ public final class JavaIdentifierNormalizer {
      *            - part of package name
      * @return normalized name
      */
-    public static String normalizePartialPackageName(final String packageNamePart) {
+    static String normalizePartialPackageName(final String packageNamePart) {
         // if part of package name consist from java or windows reserved word, return it with
         // underscore at the end and in lower case
         final String lowerPart = packageNamePart.toLowerCase();
-        if (BindingMapping.JAVA_RESERVED_WORDS.contains(lowerPart)
-                || BindingMapping.WINDOWS_RESERVED_WORDS.contains(packageNamePart.toUpperCase())) {
+        if (BindingMapping.JAVA_RESERVED_WORDS.contains(lowerPart) || WINDOWS_RESERVED_WORDS.contains(lowerPart)) {
             return lowerPart + UNDERSCORE;
         }
 
@@ -328,7 +329,8 @@ public final class JavaIdentifierNormalizer {
      *            - name of identifier
      * @return - java acceptable identifier
      */
-    public static String normalizeClassIdentifier(final String packageName, final String className) {
+    static String normalizeClassIdentifier(final String packageName, final String className,
+            ModuleContext context) {
         if (packageName.isEmpty() && PRIMITIVE_TYPES.contains(className)) {
             return className;
         }
@@ -338,32 +340,19 @@ public final class JavaIdentifierNormalizer {
             }
         }
         final String convertedClassName = normalizeSpecificIdentifier(className, JavaIdentifier.CLASS);
-        // if packageName contains class name at the end, then the className is
-        // name of inner class
-        final String[] packageNameParts = packageName.split("\\.");
-        String suppInnerClassPackageName = packageName;
-        if (packageNameParts.length > 1) {
-            if (Character.isUpperCase(packageNameParts[packageNameParts.length - 1].charAt(FIRST_CHAR))) {
-                final StringBuilder sb = new StringBuilder();
-                // ignore class name in package name - inner class name has
-                // to be normalizing according to original package of parent
-                // class
-                for (int i = 0; i < packageNameParts.length - 1; i++) {
-                    if (!Character.isUpperCase(packageNameParts[i].charAt(FIRST_CHAR))) {
-                        sb.append(packageNameParts[i]);
-                        if (i != packageNameParts.length - 2 &&
-                                !Character.isUpperCase(packageNameParts[i+1].charAt(FIRST_CHAR))) {
-                            sb.append('.');
-                        }
-                    } else {
-                        break;
-                    }
-                }
-                suppInnerClassPackageName = sb.toString();
-            }
+
+        // if packageName contains class name at the end, then the className is name of inner class
+        final String basePackageName;
+        final int lastDot = packageName.lastIndexOf('.');
+        if (lastDot != -1 && Character.isUpperCase(packageName.charAt(lastDot + 1))) {
+            // ignore class name in package name - inner class name has to be normalized according to original package
+            // of parent class
+            basePackageName = packageName.substring(0, lastDot);
+        } else {
+            basePackageName = packageName;
         }
 
-        return normalizeClassIdentifier(suppInnerClassPackageName, convertedClassName, convertedClassName, FIRST_INDEX);
+        return normalizeClassIdentifier(basePackageName, convertedClassName, convertedClassName, 1, context);
     }
 
     /**
@@ -377,23 +366,20 @@ public final class JavaIdentifierNormalizer {
      * @return - java acceptable identifier
      */
     public static String normalizeSpecificIdentifier(final String identifier, final JavaIdentifier javaIdentifier) {
-        final StringBuilder sb = new StringBuilder();
-
         // if identifier isn't PACKAGE type then check it by reserved keywords
-        if(javaIdentifier != JavaIdentifier.PACKAGE) {
-            if (BindingMapping.JAVA_RESERVED_WORDS.contains(identifier.toLowerCase())
-                    || BindingMapping.WINDOWS_RESERVED_WORDS.contains(identifier.toUpperCase())) {
-                return fixCasesByJavaType(
-                        sb.append(identifier).append(UNDERSCORE).append(RESERVED_KEYWORD).toString().toLowerCase(),
-                        javaIdentifier);
+        if (javaIdentifier != JavaIdentifier.PACKAGE) {
+            final String lower = identifier.toLowerCase();
+            if (BindingMapping.JAVA_RESERVED_WORDS.contains(lower) || WINDOWS_RESERVED_WORDS.contains(lower)) {
+                return fixCasesByJavaType(lower + UNDERSCORE + RESERVED_KEYWORD, javaIdentifier);
             }
         }
 
         // check and convert first char in identifier if there is non-java char
-        final char firstChar = identifier.charAt(FIRST_CHAR);
+        final StringBuilder sb = new StringBuilder();
+        final char firstChar = identifier.charAt(0);
         if (!Character.isJavaIdentifierStart(firstChar)) {
             // converting first char of identifier
-            sb.append(convertFirst(firstChar, existNext(identifier, FIRST_CHAR)));
+            sb.append(convertFirst(firstChar, existNext(identifier, 0)));
         } else {
             sb.append(firstChar);
         }
@@ -402,7 +388,7 @@ public final class JavaIdentifierNormalizer {
             final char actualChar = identifier.charAt(i);
             // ignore single dash as non java char - if there is more dashes in a row or dash is as
             // the last char in identifier then parse these dashes as non java chars
-            if (actualChar == '-' && existNext(identifier, i)) {
+            if (actualChar == DASH && existNext(identifier, i)) {
                 if (identifier.charAt(i - 1) != DASH && identifier.charAt(i + 1) != DASH) {
                     sb.append(UNDERSCORE);
                     continue;
@@ -434,24 +420,28 @@ public final class JavaIdentifierNormalizer {
      * @return converted identifier
      */
     private static String normalizeClassIdentifier(final String packageName, final String origClassName,
-            final String actualClassName, final int rank) {
+            final String actualClassName, final int rank, ModuleContext context) {
 
-        // FIXME: this does not look thread-safe and seems to leak memory
-        if (PACKAGES_MAP.containsKey(packageName)) {
-            for (final String existingName : PACKAGES_MAP.get(packageName)) {
-                if (actualClassName.equalsIgnoreCase(existingName)) {
-                    return normalizeClassIdentifier(packageName, origClassName, origClassName + rank, rank + 1);
+        final ListMultimap<String, String> packagesMap = context.getPackagesMap();
+
+        synchronized (packagesMap) {
+            if (packagesMap.containsKey(packageName)) {
+                for (final String existingName : packagesMap.get(packageName)) {
+                    if (actualClassName.equalsIgnoreCase(existingName)) {
+                       return normalizeClassIdentifier(packageName, origClassName, origClassName + rank,
+                     rank + 1, context);
+                    }
                 }
             }
+            context.putToPackagesMap(packageName, actualClassName);
+            return actualClassName;
         }
-        PACKAGES_MAP.put(packageName, actualClassName);
-        return actualClassName;
     }
 
     /**
      * Fix cases of converted identifiers by Java type
      *
-     * @param string
+     * @param convertedIdentifier
      *            - converted identifier
      * @param javaIdentifier
      *            - java type of identifier
@@ -548,7 +538,7 @@ public final class JavaIdentifierNormalizer {
      *            - string to be capitalized
      */
     private static String capitalize(final String identifier) {
-        return identifier.substring(FIRST_CHAR, FIRST_CHAR + 1).toUpperCase() + identifier.substring(1);
+        return identifier.substring(0, 1).toUpperCase() + identifier.substring(1);
     }
 
     private static String convertIdentifierEnumValue(final String name, final String origName, final List<Pair> values,