Class NameUtils

java.lang.Object
io.micronaut.starter.util.NameUtils
public final class NameUtils extends Object

  • Field Details

  • Method Details

    • parseProjectIdentifier

      public static ProjectIdentifier parseProjectIdentifier(String name) throws IllegalArgumentException
      Throws:
      IllegalArgumentException

    • isValidAppName

      public static boolean isValidAppName(String appName)
      verifies the app is not blank, null or matches micronaut
      Parameters:
      appName - Application's name
      Returns:
      True if it is valid

    • parse

      public static Project parse(String name) throws IllegalArgumentException
      Throws:
      IllegalArgumentException

    • isValidServiceId

      public static boolean isValidServiceId(String name)
      Checks whether the given name is a valid service identifier.
      Parameters:
      name - The name
      Returns:
      True if it is

    • 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 - The property name
      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
      Returns:
      The full 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
      Returns:
      the full 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 Micronaut artifact given the Micronaut class and a specified trailing name.
      Parameters:
      clazz - The class
      trailingName - The trailing name such as "Controller" or "Service"
      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(String className, String trailingName)
      Parameters:
      className - The class name
      trailingName - The trailing name
      Returns:
      The logical property name

    • 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 from which to get a short name
      Returns:
      The short name of the class

    • getPackageName

      public static String getPackageName(String className)
      Returns the package name without the class.
      Parameters:
      className - The class name from which to get a package name
      Returns:
      The short name 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.

    • 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

    • getNaturalNameOfEnum

      public static String getNaturalNameOfEnum(String name)
      Converts an enum style name into its natural language equivalent eg ('FIRST_NAME' becomes 'First Name').
      Parameters:
      name - The string 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 NameUtils to have a dependency on any external library to minimise the number of dependencies required to bootstrap Micronaut.

      Parameters:
      str - The string to test.
      Returns:
      true if the string is null, or blank.

    • 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

    • isGetter

      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

    • isPropertyMethodSuffix

      protected static boolean isPropertyMethodSuffix(String suffix)
      This method is used when interrogating a method name to determine if the method represents a property getter. For example, if a method is named getSomeProperty, the value "SomeProperty" could be passed to this method to determine that the method should be considered a property getter. Examples of suffixes that would be considered property getters:
      • SomeProperty
      • Word
      • aProperty
      • S
      • X567

      Examples of suffixes that would not be considered property getters:

      • someProperty
      • word
      • s
      • x567
      • 2other
      • 5

      A suffix like prop from a method getprop() is not recognized as a valid suffix. However Groovy will recognize such a method as a property getter but only if a method getProp() or a property prop does not also exist. The Java Beans specification is unclear on how to treat such method names, it only says that "by default" the suffix will start with a capital letter because of the camel case style usually used. (See the JavaBeans API specification sections 8.3 and 8.8.)

      This method assumes that all characters in the name are valid Java identifier letters.

      Parameters:
      suffix - The suffix to inspect
      Returns:
      true if suffix indicates a property name

    • 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