Package grails.util

Class GrailsNameUtils

java.lang.Object
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!

  • Method Details

    • getSetterName

      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

    • getGetterName

      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

    • getClassName

      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

    • getFullClassName

      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

    • getFullClassName

      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

    • getClassName

      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

    • getClassNameRepresentation

      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

    • getLogicalName

      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

    • getLogicalName

      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

    • getLogicalPropertyName

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

    • getLogicalPropertyName

      public static String getLogicalPropertyName(String className, String trailingName)

    • getPropertyName

      public static String getPropertyName(String name)
      Shorter version of getPropertyNameRepresentation.
      Parameters:
      name - The name to convert
      Returns:
      The property name version

    • getPropertyName

      public static String getPropertyName(Class<?> clazz)
      Shorter version of getPropertyNameRepresentation.
      Parameters:
      clazz - The clazz to convert
      Returns:
      The property name version

    • getPropertyNameRepresentation

      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)

    • getPropertyNameRepresentation

      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

    • getPropertyNameForLowerCaseHyphenSeparatedName

      public static String getPropertyNameForLowerCaseHyphenSeparatedName(String name)
      Converts foo-bar into fooBar.
      Parameters:
      name - The lower case hyphen separated name
      Returns:
      The property name equivalent

    • getShortName

      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

    • getShortName

      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

    • getPackageName

      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

    • getScriptName

      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

    • getScriptName

      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.

    • getSnakeCaseName

      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

    • getSnakeCaseName

      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.

    • getNameFromScript

      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

    • getPluginName

      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".
      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.
      Throws:
      IllegalArgumentException - if the given descriptor name is not valid, i.e. if it doesn't end with "GrailsPlugin.groovy".

    • getNaturalName

      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

    • isBlank

      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.

    • getPropertyNameConvention

      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

    • isValidJavaPackage

      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

    • isValidJavaIdentifier

      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

    • getPropertyNameConvention

      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

    • getPropertyForGetter

      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

    • getPropertyForGetter

      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

    • getPropertyForGetter

      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

    • isGetter

      @Deprecated public static boolean isGetter(String name, Class<?>[] args)
      Deprecated.
      use isGetter(String, Class, Class[]) instead because this method has a defect for "is.." method with Boolean return types.
      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
      args - The arguments
      Returns:
      true if it is a javabean property getter

    • isGetter

      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

    • getPropertyForSetter

      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