001/* 002 * Portions of this software was developed by employees of the National Institute 003 * of Standards and Technology (NIST), an agency of the Federal Government and is 004 * being made available as a public service. Pursuant to title 17 United States 005 * Code Section 105, works of NIST employees are not subject to copyright 006 * protection in the United States. This software may be subject to foreign 007 * copyright. Permission in the United States and in foreign countries, to the 008 * extent that NIST may hold copyright, to use, copy, modify, create derivative 009 * works, and distribute this software and its documentation without fee is hereby 010 * granted on a non-exclusive basis, provided that this notice and disclaimer 011 * of warranty appears in all copies. 012 * 013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 025 */ 026 027package gov.nist.secauto.metaschema.databind.codegen; 028 029import gov.nist.secauto.metaschema.databind.codegen.impl.NameConverter; 030 031import edu.umd.cs.findbugs.annotations.NonNull; 032 033/** 034 * A variety of utility methods for normalizing Java class related names. 035 */ 036public final class ClassUtils { 037 private ClassUtils() { 038 // disable construction 039 } 040 041 /** 042 * Transforms the provided name into a string suitable for use as a Java 043 * property name. 044 * 045 * @param name 046 * the name of an information element definition 047 * @return a Java property name 048 */ 049 @SuppressWarnings("null") 050 @NonNull 051 public static String toPropertyName(@NonNull String name) { 052 return NameConverter.STANDARD.toPropertyName(name); 053 } 054 055 /** 056 * Transforms the provided name into a string suitable for use as a Java 057 * variable name. 058 * 059 * @param name 060 * the name of an information element definition 061 * @return a Java variable name 062 */ 063 @SuppressWarnings("null") 064 @NonNull 065 public static String toVariableName(@NonNull String name) { 066 return NameConverter.STANDARD.toVariableName(name); 067 } 068 069 /** 070 * Transforms the provided name into a string suitable for use as a Java class 071 * name. 072 * 073 * @param name 074 * the name of an information element definition 075 * @return a Java variable name 076 */ 077 @SuppressWarnings("null") 078 @NonNull 079 public static String toClassName(@NonNull String name) { 080 return NameConverter.STANDARD.toClassName(name); 081 } 082 083 /** 084 * Transforms the provided name into a string suitable for use as a Java package 085 * name. 086 * 087 * @param name 088 * the name of an information element definition 089 * @return a Java variable name 090 */ 091 @SuppressWarnings("null") 092 @NonNull 093 public static String toPackageName(@NonNull String name) { 094 return NameConverter.STANDARD.toPackageName(name); 095 } 096 097}