GrailsNameUtils (Grace Framework

grails.util.GrailsNameUtils

```
public final class GrailsNameUtils
extends Object
```
Utility methods for converting between different name types, for example from class names -> property names and vice-versa. The key aspect of this class is that it has no dependencies outside the JDK!

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public static String`	`getClassName(String logicalName, String trailingName)` Returns the class name for the given logical name and trailing name.
	`public static String`	`getClassName(String logicalName)` Return the class name for the given logical name.
	`public static String`	`getClassNameRepresentation(String name)` Returns the class name representation of the given name
	`public static String`	`getFullClassName(Class<?> cls)` Returns the class name, including package, for the given class.
	`public static String`	`getFullClassName(String className)` Returns the class name, including package, for the given class.
	`public static String`	`getGetterName(String propertyName)` Calculate the name for a getter method to retrieve the specified property
	`public static String`	`getLogicalName(Class<?> clazz, String trailingName)` Retrieves the logical class name of a Grails artifact given the Grails class and a specified trailing name.
	`public static String`	`getLogicalName(String name, String trailingName)` Retrieves the logical name of the class without the trailing name
	`public static String`	`getLogicalPropertyName(Class<?> clazz, String trailingName)`
	`public static String`	`getLogicalPropertyName(String className, String trailingName)`
	`public static String`	`getNameFromScript(String scriptName)` Calculates the class name from a script name in the form my-funk-grails-script.
	`public static String`	`getNaturalName(String name)` Converts a property name into its natural language equivalent eg ('firstName' becomes 'First Name')
	`public static String`	`getPackageName(String className)` Returns the package prefix without the class name eg ('a.b.ClassName' becomes 'a.b').
	`public static String`	`getPluginName(String descriptorName)` Returns the name of a plugin given the name of the *GrailsPlugin.groovy descriptor file.
	`public static String`	`getPropertyForGetter(String getterName)` Returns a property name equivalent for the given getter name or null if it is not a valid getter.
	`public static String`	`getPropertyForGetter(String getterName, Class<?> returnType)` Returns a property name equivalent for the given getter name and return type or null if it is not a valid getter.
	`public static String`	`getPropertyForGetter(String getterName, String returnType)` Returns a property name equivalent for the given getter name and return type or null if it is not a valid getter.
	`public static String`	`getPropertyForSetter(String setterName)` Returns a property name equivalent for the given setter name or null if it is not a valid setter.
	`public static String`	`getPropertyName(String name)` Shorter version of getPropertyNameRepresentation.
	`public static String`	`getPropertyName(Class<?> clazz)` Shorter version of getPropertyNameRepresentation.
	`public static String`	`getPropertyNameConvention(Object object)` Returns an appropriate property name for the given object.
	`public static String`	`getPropertyNameConvention(Object object, String suffix)` Returns an appropriate property name for the given object.
	`public static String`	`getPropertyNameForLowerCaseHyphenSeparatedName(String name)` Converts foo-bar into fooBar.
	`public static String`	`getPropertyNameRepresentation(Class<?> targetClass)` Returns the property name equivalent for the specified class.
	`public static String`	`getPropertyNameRepresentation(String name)` Returns the property name representation of the given name.
	`public static String`	`getScriptName(Class<?> clazz)` Retrieves the script name representation of the supplied class.
	`public static String`	`getScriptName(String name)` Retrieves the script name representation of the given class name.
	`public static String`	`getSetterName(String propertyName)` Retrieves the name of a setter for the specified property name
	`public static String`	`getShortName(Class<?> targetClass)` Returns the class name without the package prefix.
	`public static String`	`getShortName(String className)` Returns the class name without the package prefix.
	`public static String`	`getSnakeCaseName(Class<?> clazz)` Retrieves the snake case name of the supplied class.
	`public static String`	`getSnakeCaseName(String name)` Retrieves the snake case name of the given class name.
	`public static boolean`	`isBlank(String str)`
	`public static boolean`	`isGetter(String name, Class<?>[] args)` Returns true if the name of the method specified and the number of arguments make it a javabean property getter.
	`public static boolean`	`isGetter(String name, Class<?> returnType, Class<?>[] args)` Returns true if the name of the method specified and the number of arguments make it a javabean property getter.
	`public static boolean`	`isValidJavaIdentifier(String name)` Test whether the given name is a valid Java identifier
	`public static boolean`	`isValidJavaPackage(String packageName)` Test whether the give package name is a valid Java package

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Method Detail
  - public static String getClassName(String logicalName, String trailingName)
    
    Returns the class name for the given logical name and trailing name. For example "person" and "Controller" would evaluate to "PersonController"
    Parameters:
    logicalName - The logical name
    trailingName - The trailing name
    Returns:
    The class name
  - public static String getClassName(String logicalName)
    
    Return the class name for the given logical name. For example "person" would evaluate to "Person"
    Parameters:
    logicalName - The logical name
    Returns:
    The class name
  - public static String getClassNameRepresentation(String name)
    
    Returns the class name representation of the given name
    Parameters:
    name - The name to convert
    Returns:
    The property name representation
  - public static String getFullClassName(Class<?> cls)
    
    Returns the class name, including package, for the given class. This method will deals with proxies and closures.
    Parameters:
    cls - The class name
  - public static String getFullClassName(String className)
    
    Returns the class name, including package, for the given class. This method will deals with proxies and closures.
    Parameters:
    className - The class name
  - public static String getGetterName(String propertyName)
    
    Calculate the name for a getter method to retrieve the specified property
    Parameters:
    propertyName
    Returns:
    The name for the getter method for this property, if it were to exist, i.e. getConstraints
  - public static String getLogicalName(Class<?> clazz, String trailingName)
    
    Retrieves the logical class name of a Grails artifact given the Grails class and a specified trailing name.
    Parameters:
    clazz - The class
    trailingName - The trailing name such as "Controller" or "TagLib"
    Returns:
    The logical class name
  - public static String getLogicalName(String name, String trailingName)
    
    Retrieves the logical name of the class without the trailing name
    Parameters:
    name - The name of the class
    trailingName - The trailing name
    Returns:
    The logical name
  - public static String getLogicalPropertyName(Class<?> clazz, String trailingName)
  - public static String getLogicalPropertyName(String className, String trailingName)
  - public static String getNameFromScript(String scriptName)
    
    Calculates the class name from a script name in the form my-funk-grails-script.
    Parameters:
    scriptName - The script name
    Returns:
    A class name
  - public static String getNaturalName(String name)
    
    Converts a property name into its natural language equivalent eg ('firstName' becomes 'First Name')
    Parameters:
    name - The property name to convert
    Returns:
    The converted property name
  - public static String getPackageName(String className)
    
    Returns the package prefix without the class name eg ('a.b.ClassName' becomes 'a.b').
    Parameters:
    className - The class name to get the package prefix for
    Returns:
    The package prefix of the class
  - public static String getPluginName(String descriptorName)
    
    Returns the name of a plugin given the name of the *GrailsPlugin.groovy descriptor file. For example, "DbUtilsGrailsPlugin.groovy" gives "db-utils".
    throws:
    IllegalArgumentException if the given descriptor name is not valid, i.e. if it doesn't end with "GrailsPlugin.groovy".
    
    Parameters:
    descriptorName - The simple name of the plugin descriptor.
    Returns:
    The plugin name for the descriptor, or null if descriptorName is null, or an empty string if descriptorName is an empty string.
  - public static String getPropertyForGetter(String getterName)
    
    Returns a property name equivalent for the given getter name or null if it is not a valid getter. If not null or empty the getter name is assumed to be a valid identifier.
    Parameters:
    getterName - The getter name
    Returns:
    The property name equivalent
  - public static String getPropertyForGetter(String getterName, Class<?> returnType)
    
    Returns a property name equivalent for the given getter name and return type or null if it is not a valid getter. If not null or empty the getter name is assumed to be a valid identifier.
    Parameters:
    getterName - The getter name
    returnType - The type the method returns
    Returns:
    The property name equivalent
  - public static String getPropertyForGetter(String getterName, String returnType)
    
    Returns a property name equivalent for the given getter name and return type or null if it is not a valid getter. If not null or empty the getter name is assumed to be a valid identifier.
    Parameters:
    getterName - The getter name
    returnType - The type the method returns
    Returns:
    The property name equivalent
  - public static String getPropertyForSetter(String setterName)
    
    Returns a property name equivalent for the given setter name or null if it is not a valid setter. If not null or empty the setter name is assumed to be a valid identifier.
    Parameters:
    setterName - The setter name, must be null or empty or a valid identifier name
    Returns:
    The property name equivalent
  - public static String getPropertyName(String name)
    
    Shorter version of getPropertyNameRepresentation.
    Parameters:
    name - The name to convert
    Returns:
    The property name version
  - public static String getPropertyName(Class<?> clazz)
    
    Shorter version of getPropertyNameRepresentation.
    Parameters:
    clazz - The clazz to convert
    Returns:
    The property name version
  - public static String getPropertyNameConvention(Object object)
    
    Returns an appropriate property name for the given object. If the object is a collection will append List, Set, Collection or Map to the property name
    Parameters:
    object - The object
    Returns:
    The property name convention
  - @SuppressWarnings("rawtypes")
    public static String getPropertyNameConvention(Object object, String suffix)
    
    Returns an appropriate property name for the given object. If the object is a collection will append List, Set, Collection or Map to the property name
    Parameters:
    object - The object
    suffix - The suffix to append to the name.
    Returns:
    The property name convention
  - public static String getPropertyNameForLowerCaseHyphenSeparatedName(String name)
    
    Converts foo-bar into fooBar.
    Parameters:
    name - The lower case hyphen separated name
    Returns:
    The property name equivalent
  - public static String getPropertyNameRepresentation(Class<?> targetClass)
    
    Returns the property name equivalent for the specified class.
    Parameters:
    targetClass - The class to get the property name for
    Returns:
    A property name reperesentation of the class name (eg. MyClass becomes myClass)
  - public static String getPropertyNameRepresentation(String name)
    
    Returns the property name representation of the given name.
    Parameters:
    name - The name to convert
    Returns:
    The property name representation
  - public static String getScriptName(Class<?> clazz)
    
    Retrieves the script name representation of the supplied class. For example MyFunkyGrailsScript would be my-funky-grails-script.
    Parameters:
    clazz - The class to convert
    Returns:
    The script name representation
  - public static String getScriptName(String name)
    
    Retrieves the script name representation of the given class name. For example MyFunkyGrailsScript would be my-funky-grails-script.
    Parameters:
    name - The class name to convert.
    Returns:
    The script name representation.
  - public static String getSetterName(String propertyName)
    
    Retrieves the name of a setter for the specified property name
    Parameters:
    propertyName - The property name
    Returns:
    The setter equivalent
  - public static String getShortName(Class<?> targetClass)
    
    Returns the class name without the package prefix.
    Parameters:
    targetClass - The class to get a short name for
    Returns:
    The short name of the class
  - public static String getShortName(String className)
    
    Returns the class name without the package prefix.
    Parameters:
    className - The class name to get a short name for
    Returns:
    The short name of the class
  - public static String getSnakeCaseName(Class<?> clazz)
    
    Retrieves the snake case name of the supplied class. For example MyFunkyGrailsScript would be my_funky_grails_script.
    Parameters:
    clazz - The class to convert
    Returns:
    The script name representation
  - public static String getSnakeCaseName(String name)
    
    Retrieves the snake case name of the given class name. For example MyFunkyGrailsScript would be my_funky_grails_script.
    Parameters:
    name - The class name to convert.
    Returns:
    The snake case name representation.
  - public static boolean isBlank(String str)
    
    Determines whether a given string is null, empty, or only contains whitespace. If it contains anything other than whitespace then the string is not considered to be blank and the method returns false.
    
    We could use Commons Lang for this, but we don't want GrailsNameUtils to have a dependency on any external library to minimise the number of dependencies required to bootstrap Grails.
    
    Parameters:
    str - The string to test.
    Returns:
    true if the string is null, or blank.
  - @Deprecated
    public static boolean isGetter(String name, Class<?>[] args)
    
    Returns true if the name of the method specified and the number of arguments make it a javabean property getter. The name is assumed to be a valid Java method name, that is not verified.
    deprecated:
    use isGetter(String, Class, Class[]) instead because this method has a defect for "is.." method with Boolean return types.
    
    Parameters:
    name - The name of the method
    args - The arguments
    Returns:
    true if it is a javabean property getter
  - public static boolean isGetter(String name, Class<?> returnType, Class<?>[] args)
    
    Returns true if the name of the method specified and the number of arguments make it a javabean property getter. The name is assumed to be a valid Java method name, that is not verified.
    Parameters:
    name - The name of the method
    returnType - The return type of the method
    args - The arguments
    Returns:
    true if it is a javabean property getter
  - public static boolean isValidJavaIdentifier(String name)
    
    Test whether the given name is a valid Java identifier
    Parameters:
    name - The name
    Returns:
    True if it is
  - public static boolean isValidJavaPackage(String packageName)
    
    Test whether the give package name is a valid Java package
    Parameters:
    packageName - The name of the package
    Returns:
    True if it is valid

Summary:
Method

| Detail:
Method

[Java] Class GrailsNameUtils

Methods Summary

Inherited Methods Summary

Method Detail

public static String getClassName(String logicalName, String trailingName)

public static String getClassName(String logicalName)

public static String getClassNameRepresentation(String name)

public static String getFullClassName(Class<?> cls)

public static String getFullClassName(String className)

public static String getGetterName(String propertyName)

public static String getLogicalName(Class<?> clazz, String trailingName)

public static String getLogicalName(String name, String trailingName)

public static String getLogicalPropertyName(Class<?> clazz, String trailingName)

public static String getLogicalPropertyName(String className, String trailingName)

public static String getNameFromScript(String scriptName)

public static String getNaturalName(String name)

public static String getPackageName(String className)

public static String getPluginName(String descriptorName)

public static String getPropertyForGetter(String getterName)

public static String getPropertyForGetter(String getterName, Class<?> returnType)

public static String getPropertyForGetter(String getterName, String returnType)

public static String getPropertyForSetter(String setterName)

public static String getPropertyName(String name)

public static String getPropertyName(Class<?> clazz)

public static String getPropertyNameConvention(Object object)

@SuppressWarnings("rawtypes")public static String getPropertyNameConvention(Object object, String suffix)

public static String getPropertyNameForLowerCaseHyphenSeparatedName(String name)

public static String getPropertyNameRepresentation(Class<?> targetClass)

public static String getPropertyNameRepresentation(String name)

public static String getScriptName(Class<?> clazz)

public static String getScriptName(String name)

public static String getSetterName(String propertyName)

public static String getShortName(Class<?> targetClass)

public static String getShortName(String className)

public static String getSnakeCaseName(Class<?> clazz)

public static String getSnakeCaseName(String name)

public static boolean isBlank(String str)

@Deprecatedpublic static boolean isGetter(String name, Class<?>[] args)

public static boolean isGetter(String name, Class<?> returnType, Class<?>[] args)

public static boolean isValidJavaIdentifier(String name)

public static boolean isValidJavaPackage(String packageName)

@SuppressWarnings("rawtypes")
public static String getPropertyNameConvention(Object object, String suffix)

@Deprecated
public static boolean isGetter(String name, Class<?>[] args)