1 /*
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.metaschema.databind.codegen;
28
29 import gov.nist.secauto.metaschema.databind.codegen.impl.NameConverter;
30
31 import edu.umd.cs.findbugs.annotations.NonNull;
32
33 /**
34 * A variety of utility methods for normalizing Java class related names.
35 */
36 public final class ClassUtils {
37 private ClassUtils() {
38 // disable construction
39 }
40
41 /**
42 * Transforms the provided name into a string suitable for use as a Java
43 * property name.
44 *
45 * @param name
46 * the name of an information element definition
47 * @return a Java property name
48 */
49 @SuppressWarnings("null")
50 @NonNull
51 public static String toPropertyName(@NonNull String name) {
52 return NameConverter.STANDARD.toPropertyName(name);
53 }
54
55 /**
56 * Transforms the provided name into a string suitable for use as a Java
57 * variable name.
58 *
59 * @param name
60 * the name of an information element definition
61 * @return a Java variable name
62 */
63 @SuppressWarnings("null")
64 @NonNull
65 public static String toVariableName(@NonNull String name) {
66 return NameConverter.STANDARD.toVariableName(name);
67 }
68
69 /**
70 * Transforms the provided name into a string suitable for use as a Java class
71 * name.
72 *
73 * @param name
74 * the name of an information element definition
75 * @return a Java variable name
76 */
77 @SuppressWarnings("null")
78 @NonNull
79 public static String toClassName(@NonNull String name) {
80 return NameConverter.STANDARD.toClassName(name);
81 }
82
83 /**
84 * Transforms the provided name into a string suitable for use as a Java package
85 * name.
86 *
87 * @param name
88 * the name of an information element definition
89 * @return a Java variable name
90 */
91 @SuppressWarnings("null")
92 @NonNull
93 public static String toPackageName(@NonNull String name) {
94 return NameConverter.STANDARD.toPackageName(name);
95 }
96
97 }