View Javadoc
1   /**
2    * This file Copyright (c) 2016-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.config.registry;
35  
36  import org.atteo.evo.inflector.English;
37  
38  /**
39   * Common utility for humanizing the {@link Registry} name. Provides methods for turning an arbitrary name to camel-case and
40   * for retrieving a plural camel-cased registry name.
41   */
42  public class RegistryTypeNameUtil {
43  
44      public static String pluralTypeNameOf(DefinitionType definitionType) {
45          return English.plural(typeNameOf(definitionType));
46      }
47  
48      public static String typeNameOf(DefinitionType definitionType) {
49          final String name = definitionType.getName();
50          return camelCase(name);
51      }
52  
53      /**
54       * @deprecated since 5.5 - use {@link #pluralTypeNameOf(DefinitionType)} instead.
55       */
56      @Deprecated
57      public static String pluralTypeNameOf(Registry registry) {
58          return pluralTypeNameOf(registry.type());
59      }
60  
61      /**
62       * @deprecated since 5.5 - use {@link #typeNameOf(DefinitionType)} instead.
63       */
64      @Deprecated
65      public static String typeNameOf(Registry registry) {
66          return typeNameOf(registry.type());
67      }
68  
69      private static String camelCase(String name) {
70          // We used to use Guava's CaseFormat with CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.LOWER_CAMEL, registry.type().name());
71          // But this also completely lower-cased names that were already in camelCase.
72          // Let's go old school and do it ourselves.
73          final StringBuilder newValue = new StringBuilder();
74          final char[] chars = name.toCharArray();
75          for (int i = 0; i < chars.length; i++) {
76              char c = chars[i];
77              if ('_' == c) {
78                  // Skip
79              } else if (Character.isUpperCase(c) && i > 0) {
80                  // check previous
81                  if (Character.isUpperCase(chars[i - 1])) {
82                      newValue.append(Character.toLowerCase(c));
83                  } else {
84                      // If the previous isn't uppercase then we can assume this is a Capital in camelCase
85                      newValue.append(c);
86                  }
87              } else {
88                  newValue.append(Character.toLowerCase(c));
89              }
90          }
91  
92          return newValue.toString();
93      }
94  }