NameUtils (micronaut 1.2.6 API)

java.lang.Object
- io.micronaut.core.naming.NameUtils

```
public class NameUtils
extends Object
```
Naming convention utilities.

Since:

1.0

Author:

Graeme Rocher

Constructor Summary

Constructors
Constructor and Description

NameUtils()

Constructors
Constructor and Description
`NameUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`camelCase(String str)` The camel case version of the string with the first letter in lower case.
`static String`	`camelCase(String str, boolean lowerCaseFirstLetter)` The camel case version of the string with the first letter in lower case.
`static String`	`capitalize(String name)` Converts a property name to class name according to the JavaBean convention.
`static String`	`decapitalize(String name)` Decapitalizes a given string according to the rule: If the first or only character is Upper Case, it is made Lower Case UNLESS the second character is also Upper Case, when the String is returned unchanged .
`static String`	`decapitalizeWithoutSuffix(String name, String... suffixes)` Converts class name to property name using JavaBean decapitalization.
`static String`	`dehyphenate(String name)` Converts hyphenated, lower-case form to camel-case form.
`static String`	`environmentName(String camelCase)` Returns the underscore separated version of the given camel case string.
`static String`	`extension(String filename)` Retrieves the extension of a file name.
`static String`	`filename(String path)` Retrieves the fileName of a file without extension.
`static String`	`getPackageName(String className)` Returns the package name for a class represented as string.
`static String`	`getPropertyNameForGetter(String getterName)` Get the equivalent property name for the given getter.
`static String`	`getPropertyNameForSetter(String setterName)` Get the equivalent property name for the given setter.
`static String`	`getSimpleName(String className)` Returns the simple name for a class represented as string.
`static String`	`getterNameFor(String propertyName)` Get the equivalent getter name for the given property.
`static String`	`getterNameFor(String propertyName, boolean isBoolean)` Get the equivalent getter name for the given property.
`static String`	`getterNameFor(String propertyName, Class<?> type)` Get the equivalent getter name for the given property.
`static String`	`hyphenate(String name)` Converts camel case to hyphenated, lowercase form.
`static String`	`hyphenate(String name, boolean lowerCase)` Converts camel case to hyphenated, lowercase form.
`static boolean`	`isEnvironmentName(String str)` Checks whether the string is a valid environment-style property name.
`static boolean`	`isGetterName(String methodName)` Is the given method name a valid getter name.
`static boolean`	`isHyphenatedLowerCase(String name)` Checks whether the given name is a valid service identifier.
`static boolean`	`isSetterName(String methodName)` Is the given method name a valid setter name.
`static boolean`	`isValidHyphenatedPropertyName(String str)` Checks whether the string is a valid hyphenated (kebab-case) property name.
`static String`	`setterNameFor(String propertyName)` Get the equivalent setter name for the given property.
`static String`	`trimSuffix(String string, String... suffixes)` Trims the given suffixes.
`static String`	`underscoreSeparate(String camelCase)` Returns the underscore separated version of the given camel case string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NameUtils
```
public NameUtils()
```
- Method Detail
  - isHyphenatedLowerCase
```
public static boolean isHyphenatedLowerCase(String name)
```
    Checks whether the given name is a valid service identifier.
    
    Parameters:
    
    name - The name
    
    Returns:
    
    True if it is
  - decapitalizeWithoutSuffix
```
public static String decapitalizeWithoutSuffix(String name,
                                               String... suffixes)
```
    Converts class name to property name using JavaBean decapitalization.
    
    Parameters:
    
    name - The class name
    
    suffixes - The suffix to remove
    
    Returns:
    
    The decapitalized name
  - trimSuffix
```
public static String trimSuffix(String string,
                                String... suffixes)
```
    Trims the given suffixes.
    
    Parameters:
    
    string - The string to trim
    
    suffixes - The suffixes
    
    Returns:
    
    The trimmed string
  - capitalize
```
public static String capitalize(String name)
```
    Converts a property name to class name according to the JavaBean convention.
    
    Parameters:
    
    name - The property name
    
    Returns:
    
    The class name
  - hyphenate
```
public static String hyphenate(String name)
```
    Converts camel case to hyphenated, lowercase form.
    
    Parameters:
    
    name - The name
    
    Returns:
    
    The hyphenated string
  - hyphenate
```
public static String hyphenate(String name,
                               boolean lowerCase)
```
    Converts camel case to hyphenated, lowercase form.
    
    Parameters:
    
    name - The name
    
    lowerCase - Whether the result should be converted to lower case
    
    Returns:
    
    The hyphenated string
  - dehyphenate
```
public static String dehyphenate(String name)
```
    Converts hyphenated, lower-case form to camel-case form.
    
    Parameters:
    
    name - The hyphenated string
    
    Returns:
    
    The camel case form
  - getPackageName
```
public static String getPackageName(String className)
```
    Returns the package name for a class represented as string.
    
    Parameters:
    
    className - The class name
    
    Returns:
    
    The package name
  - underscoreSeparate
```
public static String underscoreSeparate(String camelCase)
```
    Returns the underscore separated version of the given camel case string.
    
    Parameters:
    
    camelCase - The camel case name
    
    Returns:
    
    The underscore separated version
  - environmentName
```
public static String environmentName(String camelCase)
```
    Returns the underscore separated version of the given camel case string.
    
    Parameters:
    
    camelCase - The camel case name
    
    Returns:
    
    The underscore separated version
  - getSimpleName
```
public static String getSimpleName(String className)
```
    Returns the simple name for a class represented as string.
    
    Parameters:
    
    className - The class name
    
    Returns:
    
    The simple name of the class
  - isSetterName
```
public static boolean isSetterName(String methodName)
```
    Is the given method name a valid setter name.
    
    Parameters:
    
    methodName - The method name
    
    Returns:
    
    True if it is a valid setter name
  - getPropertyNameForSetter
```
public static String getPropertyNameForSetter(String setterName)
```
    Get the equivalent property name for the given setter.
    
    Parameters:
    
    setterName - The setter
    
    Returns:
    
    The property name
  - setterNameFor
```
@Nonnull
public static String setterNameFor(@Nonnull
                                            String propertyName)
```
    Get the equivalent setter name for the given property.
    
    Parameters:
    
    propertyName - The property name
    
    Returns:
    
    The setter name
  - isGetterName
```
public static boolean isGetterName(String methodName)
```
    Is the given method name a valid getter name.
    
    Parameters:
    
    methodName - The method name
    
    Returns:
    
    True if it is a valid getter name
  - getPropertyNameForGetter
```
public static String getPropertyNameForGetter(String getterName)
```
    Get the equivalent property name for the given getter.
    
    Parameters:
    
    getterName - The getter
    
    Returns:
    
    The property name
  - getterNameFor
```
@Nonnull
public static String getterNameFor(@Nonnull
                                            String propertyName)
```
    Get the equivalent getter name for the given property.
    
    Parameters:
    
    propertyName - The property name
    
    Returns:
    
    The getter name
  - getterNameFor
```
@Nonnull
public static String getterNameFor(@Nonnull
                                            String propertyName,
                                            @Nonnull
                                            Class<?> type)
```
    Get the equivalent getter name for the given property.
    
    Parameters:
    
    propertyName - The property name
    
    type - The type of the property
    
    Returns:
    
    The getter name
  - getterNameFor
```
public static String getterNameFor(@Nonnull
                                   String propertyName,
                                   boolean isBoolean)
```
    Get the equivalent getter name for the given property.
    
    Parameters:
    
    propertyName - The property name
    
    isBoolean - Is the property a boolean
    
    Returns:
    
    The getter name
  - decapitalize
```
public static String decapitalize(String name)
```
    Decapitalizes a given string according to the rule:
    - If the first or only character is Upper Case, it is made Lower Case
    - UNLESS the second character is also Upper Case, when the String is returned unchanged .
    Parameters:
    
    name - The String to decapitalize
    
    Returns:
    
    The decapitalized version of the String
  - extension
```
public static String extension(String filename)
```
    Retrieves the extension of a file name. Ex: index.html -> html
    
    Parameters:
    
    filename - The name of the file
    
    Returns:
    
    The file extension
  - camelCase
```
public static String camelCase(String str)
```
    The camel case version of the string with the first letter in lower case.
    
    Parameters:
    
    str - The string
    
    Returns:
    
    The new string in camel case
  - camelCase
```
public static String camelCase(String str,
                               boolean lowerCaseFirstLetter)
```
    The camel case version of the string with the first letter in lower case.
    
    Parameters:
    
    str - The string
    
    lowerCaseFirstLetter - Whether the first letter is in upper case or lower case
    
    Returns:
    
    The new string in camel case
  - filename
```
public static String filename(String path)
```
    Retrieves the fileName of a file without extension. Ex: index.html -> index
    
    Parameters:
    
    path - The path of the file
    
    Returns:
    
    The file name without extension
  - isValidHyphenatedPropertyName
```
public static boolean isValidHyphenatedPropertyName(String str)
```
    Checks whether the string is a valid hyphenated (kebab-case) property name.
    
    Parameters:
    
    str - The string to check
    
    Returns:
    
    Whether is valid kebab-case or not
  - isEnvironmentName
```
public static boolean isEnvironmentName(String str)
```
    Checks whether the string is a valid environment-style property name.
    
    Parameters:
    
    str - The string to check
    
    Returns:
    
    Whether is valid environment-style property name or not

Class NameUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NameUtils

Method Detail

isHyphenatedLowerCase

decapitalizeWithoutSuffix

trimSuffix

capitalize

hyphenate

hyphenate

dehyphenate

getPackageName

underscoreSeparate

environmentName

getSimpleName

isSetterName

getPropertyNameForSetter

setterNameFor

isGetterName

getPropertyNameForGetter

getterNameFor

getterNameFor

getterNameFor

decapitalize

extension

camelCase

camelCase

filename

isValidHyphenatedPropertyName

isEnvironmentName