StringUtils (kordamp-gradle-plugins unspecified)

org.kordamp.gradle.util.StringUtils

@CompileStatic
class StringUtils
extends Object

Authors:: Andres Almiray

Since:: 0.2.0

Constructor Summary

Constructors
Constructor and description
`StringUtils ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static String`	`capitalize(String str)` Capitalizes a String (makes the first char uppercase) taking care of blank strings and single character strings.
	`static String`	`getClassName(String logicalName, String trailingName)` Returns the class name for the given logical name and trailing name.
	`static String`	`getClassNameForLowerCaseHyphenSeparatedName(String name)` Converts foo-bar into FooBar.
	`static String`	`getClassNameRepresentation(String name)` Returns the class name representation of the given name
	`static String`	`getFilenameExtension(String path)`
	`static String`	`getGetterName(String propertyName)` Calculate the name for a getter method to retrieve the specified property
	`static String`	`getHyphenatedName(Class<?> clazz)` Retrieves the hyphenated name representation of the supplied class.
	`static String`	`getHyphenatedName(String name)` Retrieves the hyphenated name representation of the given class name.
	`static String`	`getLogicalName(Class<?> clazz, String trailingName)` Retrieves the logical class name of a Griffon artifact given the Griffon class and a specified trailing name
	`static String`	`getLogicalName(String name, String trailingName)` Retrieves the logical name of the class without the trailing name
	`static String`	`getLogicalPropertyName(String className, String trailingName)`
	`static String`	`getNaturalName(String name)` Converts a property name into its natural language equivalent eg ('firstName' becomes 'First Name')
	`static String`	`getPropertyName(String name)` Shorter version of getPropertyNameRepresentation
	`static String`	`getPropertyName(Class<?> clazz)` Shorter version of getPropertyNameRepresentation
	`static String`	`getPropertyName(Method method)` Returns the property name representation of the given `Method`
	`static String`	`getPropertyNameForLowerCaseHyphenSeparatedName(String name)` Converts foo-bar into fooBar
	`static String`	`getPropertyNameRepresentation(Class<?> targetClass)` Returns the property name equivalent for the specified class
	`static String`	`getPropertyNameRepresentation(String name)` Returns the property name representation of the given name
	`static String`	`getSetterName(String propertyName)` Retrieves the name of a setter for the specified property name
	`static String`	`getShortName(Class<?> targetClass)` Returns the class name without the package prefix
	`static String`	`getShortName(String className)` Returns the class name without the package prefix
	`static boolean`	`isBlank(String str)`
	`static boolean`	`isNotBlank(String str)`
	`static String`	`join(Iterable<?> self, String separator)` Concatenates the `toString()` representation of each item in this Iterable, with the given String as a separator between each item.
	`static String`	`requireNonBlank(String str)` Checks that the specified String is not `blank`.
	`static String`	`requireNonBlank(String str, String message)` Checks that the specified String is not `blank` and throws a customized IllegalArgumentException if it is.
	`static String`	`uncapitalize(String str)` Uncapitalizes a String (makes the first char lowercase) taking care of blank strings and single character strings.

Inherited Methods Summary

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

- Constructor Detail
  - StringUtils()
- Method Detail
  - static String capitalize(String str)
    
    Capitalizes a String (makes the first char uppercase) taking care of blank strings and single character strings.
    Parameters:
    str - The String to be capitalized
    Returns:
    Capitalized version of the target string if it is not blank
  - 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
  - static String getClassNameForLowerCaseHyphenSeparatedName(String name)
    
    Converts foo-bar into FooBar. Empty and null strings are returned as-is.
    Parameters:
    name - The lower case hyphen separated name
    Returns:
    The class name equivalent.
  - 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
  - static String getFilenameExtension(String path)
  - 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
  - static String getHyphenatedName(Class<?> clazz)
    
    Retrieves the hyphenated name representation of the supplied class. For example MyFunkyGriffonThingy would be my-funky-griffon-thingy.
    Parameters:
    clazz - The class to convert
    Returns:
    The hyphenated name representation
  - static String getHyphenatedName(String name)
    
    Retrieves the hyphenated name representation of the given class name. For example MyFunkyGriffonThingy would be my-funky-griffon-thingy.
    Parameters:
    name - The class name to convert.
    Returns:
    The hyphenated name representation.
  - static String getLogicalName(Class<?> clazz, String trailingName)
    
    Retrieves the logical class name of a Griffon artifact given the Griffon class and a specified trailing name
    Parameters:
    clazz - The class
    trailingName - The trailing name such as "Controller" or "TagLib"
    Returns:
    The logical class name
  - 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
  - static String getLogicalPropertyName(String className, String trailingName)
  - 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
  - static String getPropertyName(String name)
    
    Shorter version of getPropertyNameRepresentation
    Parameters:
    name - The name to convert
    Returns:
    The property name version
  - static String getPropertyName(Class<?> clazz)
    
    Shorter version of getPropertyNameRepresentation
    Parameters:
    clazz - The clazz to convert
    Returns:
    The property name version
  - static String getPropertyName(Method method)
    
    Returns the property name representation of the given Method
    Parameters:
    method - The method to inspect
    Returns:
    The property name representation
    Since:
    3.0.0
  - static String getPropertyNameForLowerCaseHyphenSeparatedName(String name)
    
    Converts foo-bar into fooBar
    Parameters:
    name - The lower case hyphen separated name
    Returns:
    The property name equivalent
  - 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 representation of the class name (eg. MyClass becomes myClass)
  - 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
  - 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
  - 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
  - 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
  - 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.
    
    Parameters:
    str - The string to test.
    Returns:
    true if the string is null, or blank.
  - static boolean isNotBlank(String str)
    
    Determines whether a given string is not 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 true.
    
    Parameters:
    str - The string to test.
    Returns:
    true if the string is not null, nor blank.
  - @Nonnull static String join(@Nonnull Iterable<?> self, @Nullable String separator)
    
    Concatenates the toString() representation of each item in this Iterable, with the given String as a separator between each item.
    Parameters:
    self - an Iterable of objects
    separator - a String separator
    Returns:
    the joined String
  - static String requireNonBlank(String str)
    
    Checks that the specified String is not blank. This method is designed primarily for doing parameter validation in methods and constructors, as demonstrated below:
```
  Foo(String str) {*     this.str = GriffonNameUtils.requireNonBlank(str)
}* 
```
    throws:
    IllegalArgumentException if str is blank
    
    Parameters:
    str - the String to check for blank
    Returns:
    str if not blank
  - static String requireNonBlank(String str, String message)
    
    Checks that the specified String is not blank and throws a customized IllegalArgumentException if it is. This method is designed primarily for doing parameter validation in methods and constructors with multiple parameters, as demonstrated below:
```
  Foo(String str) {*     this.str = GriffonNameUtils.requireNonBlank(str, "str must not be null")
}* 
```
    throws:
    IllegalArgumentException if str is blank
    
    Parameters:
    str - the String to check for blank
    message - detail message to be used in the event that a IllegalArgumentException is thrown
    Returns:
    str if not blank
  - static String uncapitalize(String str)
    
    Uncapitalizes a String (makes the first char lowercase) taking care of blank strings and single character strings.
    Parameters:
    str - The String to be uncapitalized
    Returns:
    Uncapitalized version of the target string if it is not blank

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class StringUtils

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

StringUtils()

Method Detail

static String capitalize(String str)

static String getClassName(String logicalName, String trailingName)

static String getClassNameForLowerCaseHyphenSeparatedName(String name)

static String getClassNameRepresentation(String name)

static String getFilenameExtension(String path)

static String getGetterName(String propertyName)

static String getHyphenatedName(Class<?> clazz)

static String getHyphenatedName(String name)

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

static String getLogicalName(String name, String trailingName)

static String getLogicalPropertyName(String className, String trailingName)

static String getNaturalName(String name)

static String getPropertyName(String name)

static String getPropertyName(Class<?> clazz)

static String getPropertyName(Method method)

static String getPropertyNameForLowerCaseHyphenSeparatedName(String name)

static String getPropertyNameRepresentation(Class<?> targetClass)

static String getPropertyNameRepresentation(String name)

static String getSetterName(String propertyName)

static String getShortName(Class<?> targetClass)

static String getShortName(String className)

static boolean isBlank(String str)

static boolean isNotBlank(String str)

@Nonnull static String join(@Nonnull Iterable<?> self, @Nullable String separator)

static String requireNonBlank(String str)

static String requireNonBlank(String str, String message)

static String uncapitalize(String str)