Interface JavaNaming

Method Details

• isKeyword

  boolean isKeyword(String name)

  Returns true if the given String is a Java keyword which will cause a problem when used as a variable name.

  Parameters:

  name - The name to check.

  Returns:

  true if it is a keyword.

• isValidJavaIdentifier

  boolean isValidJavaIdentifier(String string)

  Returns true if the given String matches the production of a valid Java identifier.

  Parameters:

  string - The String to check the production of.

  Returns:

  true if the given String matches the production of a valid Java name, otherwise false.

• toJavaClassName

  String toJavaClassName(String name)

  Cuts away a leading namespace prefix (if there is one in place).

  Parameters:

  name - The XML name to convert to a Java name.

  Returns:

  A name which follows Java naming conventions.

• toJavaMemberName

  String toJavaMemberName(String name)

  Appends a leading '_' and converts the given name to a java name.

  Parameters:

  name - the XML name to convert.

  Returns:

  A Java member name starting with a leading '_'.

• toJavaMemberName

  String toJavaMemberName(String name, boolean useKeywordSubstitutions)

  Appends a leading '_' and converts the given name to a java name.

  Parameters:

  name - The XML name to convert.

  useKeywordSubstitutions - Set to true to turn on keyword substitution.

  Returns:

  A Java member name starting with a leading '_'.

• isValidPackageName

  boolean isValidPackageName(String packageName)

  Checks if the given package name is valid or not. Empty package names are considered valid!

  Parameters:

  packageName - Name of package as String with periods.

  Returns:

  true if package name is valid.

• packageToPath

  String packageToPath(String packageName)

  Converts the given Package name to it's corresponding Path. The path will be a relative path.

  Parameters:

  packageName - The package name to convert.

  Returns:

  A String containing the resulting patch.

• getQualifiedFileName

  String getQualifiedFileName(String fileName, String packageName)

  Qualifies the given fileName with the given packageName and returns the resulting file path.
  If packageName is null or a zero-length String, this method will return fileName.
  

  Parameters:

  fileName - The file name to be qualified.

  packageName - The package name to be used for qualifying.

  Returns:

  The qualified file path.

• getClassName

  String getClassName(Class clazz)

  Gets the class name without package part.

  Parameters:

  clazz - The class to retrieve the name from

  Returns:

  the class name without package part or null

• getPackageName

  String getPackageName(String className)

  Gets the package name of the given class name.

  Parameters:

  className - The class name to retrieve the package name from.

  Returns:

  The package name or the empty String if className is null or does not contain a package.

• extractFieldNameFromMethod

  String extractFieldNameFromMethod(Method method)

  Extracts the filed name part from the methods name. Mostly it cuts away the method prefix.

  Parameters:

  method - The Method to process.

  Returns:

  The extracted field name.

• extractFieldNameFromField

  String extractFieldNameFromField(Field field)

  Extracts the field name part from the Field. Mostly it cuts away prefixes like '_'.

  Parameters:

  field - the Field to process

  Returns:

  The extracted field name.

• isSetMethod

  boolean isSetMethod(Method method)

  Checks if the given method is a set method.

  Parameters:

  method - The Method to check

  Returns:

  true if it is a set method

• isCreateMethod

  boolean isCreateMethod(Method method)

  Checks if the given method is a create method.

  Parameters:

  method - The Method to check.

  Returns:

  true if it is a create method.

• isGetMethod

  boolean isGetMethod(Method method)

  Checks if the given method is a get method.

  Parameters:

  method - The Method to check.

  Returns:

  true if it is a get method.

• isIsMethod

  boolean isIsMethod(Method method)

  Checks if the given method is an is method.

  Parameters:

  method - The Method to check.

  Returns:

  true if it is an is method.

• isAddMethod

  boolean isAddMethod(Method method)

  Checks if the given method is an add method.

  Parameters:

  method - The Method to check.

  Returns:

  true if it is an add method.

• getAddMethodNameForField

  String getAddMethodNameForField(String fieldName)

  Generates the name of an add method for the given field name.

  Parameters:

  fieldName - The field name to generate a method name for.

  Returns:

  The generated add method name.

• getSetMethodNameForField

  String getSetMethodNameForField(String fieldName)

  Generates the name of a set method for the given field name.

  Parameters:

  fieldName - The field name to generate a method name for.

  Returns:

  The generated set method name.

• getGetMethodNameForField

  String getGetMethodNameForField(String fieldName)

  Generates the name of a get method for the given field name.

  Parameters:

  fieldName - The field name to generate a method name for.

  Returns:

  The generated get method name.

• getIsMethodNameForField

  String getIsMethodNameForField(String fieldName)

  Generates the name of an is method for the given field name.

  Parameters:

  fieldName - The field name to generate a method name for.

  Returns:

  The generated is method name.

• getCreateMethodNameForField

  String getCreateMethodNameForField(String fieldName)

  Generates the name of a create method for the given field name.

  Parameters:

  fieldName - The field name to generate a method name for.

  Returns:

  The generated create method name.