StringTools (Grolifant Core API)

```
public interface StringTools
```
Tools for working with strings.
Authors:
Schalk W. Cronjé
Since:
2.0

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public String`	`caseConversion(CaseFormats inputFormat, CaseFormats outputFormat, Object stringy)` Converts a string in one format to another.
	`public String`	`hashUri(URI uri)` Creates a SHA-256 hash of a URI.
	`public String`	`loadTextFromResource(String resourcePath)` Loads text from a resource file.
	`public byte[]`	`makeByteArray(Object src)` Converts a source to a byte array.
	`public byte[]`	`makeByteArrayOrNull(Object src)` Converts a source to a byte array.
	`public String`	`packageNameFromUri(URI uri)` Get final package or directory name from a URI
	`public java.util.regex.Pattern`	`patternize(Object stringy)` Converts most things to a pattern.
	`public java.util.List<java.util.regex.Pattern>`	`patternize(java.util.Collection<?> stringyThings)` Converts a collection of most things to a list of regex patterns.
	`public java.util.List<java.util.regex.Pattern>`	`patternizeDropNull(java.util.Collection<?> stringyThings)` Like patternize, but drops any nulls, or empty instances of Provider and java.util.Optional.
	`public java.util.regex.Pattern`	`patternizeOrNull(Object stringy)` Like patternize, but returns `null` rather than throwing an exception, when item is `null`, an empty { Link: Provider} or an empty java.util.Optional.
	`public Provider<byte[]>`	`provideByteArray(Object src)` Like provideByteArray(Object), but lazy-evaluates the value..
	`public Provider<byte[]>`	`provideByteArrayOrNull(Object src)` Like provideByteArrayOrNull(Object), but lazy-evaluates the value..
	`public Provider<String>`	`provideCaseConversion(CaseFormats inputFormat, CaseFormats outputFormat, Object stringy)` Converts a string in one format to another.
	`public Provider<java.util.regex.Pattern>`	`providePattern(Object stringy)` Like patternize, but does not immediately evaluate the passed parameter.
	`public Provider<java.util.regex.Pattern>`	`providePatternOrNull(Object stringy)` Like patternizeOrNull(Object), but does not evaluate the passed parameter immediately.
	`public Provider<String>`	`provideString(Object stringy)` Like stringize, but does not immediately evaluate the passed parameter.
	`public Provider<String>`	`provideStringOrNull(Object stringy)` Like stringizeOrNull(Object), but does not evaluate the passed parameter immediately.
	`public Provider<java.util.List<String>>`	`provideStrings(java.util.Collection<Object> stringyThings)` Provides a list of items to be converted to strings.
	`public Provider<java.util.List<String>>`	`provideStringsDropNull(java.util.Collection<Object> stringyThings)` Provides a list of items to be converted to strings dropping anything evaluating to `null`
	`public Provider<String>`	`provideTextFromResource(String resourcePath)` Lazy-loads text from a resource file.
	`public Provider<URI>`	`provideUri(Object uriThingy)` Similar to urize(Object), but does not evaluate the parameter immediately, only when the provider is resolved.
	`public Provider<java.util.Map<String, String>>`	`provideValues(java.util.Map<String, ?> props)` Similar to stringizeValues, but does not evaluate the parameter immediately, only when the provider is resolved.
	`public Provider<java.util.Map<String, String>>`	`provideValues(Provider<java.util.Map<String, Object>> props)` Similar to stringizeValues, but does not evaluate the parameter immediately, only when the provider is resolved.
	`public Provider<java.util.Map<String, String>>`	`provideValuesDropNull(java.util.Map<String, ?> props)` Similar to stringizeValuesDropNull(Map), but does not evaluate the parameter immediately, only when the provider is resolved.
	`public Provider<java.util.Map<String, String>>`	`provideValuesDropNull(Provider<java.util.Map<String, Object>> props)` Similar to stringizeValuesDropNull(Map), but does not evaluate the parameter immediately, only when the provider is resolved.
	`public Provider<java.util.Map<String, String>>`	`provideValuesKeepNull(java.util.Map<String, ?> props)` Lazy-evaluate the map.
	`public Provider<java.util.Map<String, String>>`	`provideValuesKeepNull(Provider<java.util.Map<String, Object>> props)` Lazy-evaluate the map.
	`public URI`	`safeUri(URI uri)` Create a URI where the user/password is masked out.
	`public String`	`stringize(Object stringy)` Converts most things to a string.
	`public java.util.List<String>`	`stringize(java.util.Collection<?> stringyThings)` Converts a collection of most things to a list of strings.
	`public java.util.List<String>`	`stringizeDropNull(java.util.Collection<?> stringyThings)` Like stringize, but drops any nulls, or empty instances of Provider and java.util.Optional.
	`public String`	`stringizeOrNull(Object stringy)` Like stringize, but returns `null` rather than throwing an exception, when item is `null`, an empty { Link: Provider} or an empty java.util.Optional.
	`public java.util.Map<String, String>`	`stringizeValues(java.util.Map<String, ?> props)` Evaluates a map of objects to a map of strings.
	`public java.util.Map<String, String>`	`stringizeValuesDropNull(java.util.Map<String, ?> props)` Like stringizeValues(Map), but drops the key, if the corresponding value is null or an empty Provider or java.util.Optional.
	`public void`	`updateStringProperty(Property<String> provider, Object stringy)` Updates a `Property<String>`.
	`public URI`	`urize(Object uriThingy)` Attempts to convert object to a URI.

- Method Detail
  - public String caseConversion(CaseFormats inputFormat, CaseFormats outputFormat, Object stringy)
    
    Converts a string in one format to another.
    Parameters:
    inputFormat - Input case format.
    outputFormat - Output case format.
    stringy - Object to convert
    Returns:
    Transformed string.
    Since:
    5.2
  - public String hashUri(URI uri)
    
    Creates a SHA-256 hash of a URI.
    Parameters:
    uri - URI to hash
    Returns:
    SHA-256 hash that is hex-encoded.
  - public String loadTextFromResource(String resourcePath)
    
    Loads text from a resource file.
    throws:
    org.gradle.api.resources.ResourceException
    
    Parameters:
    resourcePath - Resource path.
    Returns:
    Text
    Since:
    5.0
  - public byte[] makeByteArray(Object src)
    
    Converts a source to a byte array.
    Can convert the following:
    - byte[] and Byte[]
    - CharSequence including String and GString.
    - Contents of File
    - Contents of java.nio.file.Path if it is on the default file system
    Unwraps the following recursively until it gets to something of the above:
    - java.util.regex.Pattern.
    - Groovy Closures.
    - java.util.concurrent.Callable
    - java.util.Optional
    - Provider
    - java.util.function.Supplier
    Be careful when passing large files for conversion as all of the content will be read into memory.
    
    Parameters:
    src - Anything providing a byte[], a Byte[], or a string in some form other. Usual recursive unwrapping will occur, before evaluation. Empty wrappers and null are not accepted.
    Returns:
    A native byte[].
    Since:
    5.0
  - public byte[] makeByteArrayOrNull(Object src)
    
    Converts a source to a byte array.
    Parameters:
    src - Anything providing a byte[], a Byte[], or a string in some form other. Usual recursive unwrapping will occur, before evaluation.
    Returns:
    A native byte[] or null if null or an empty wrapper is supplied.
    Since:
    5.0
  - public String packageNameFromUri(URI uri)
    
    Get final package or directory name from a URI
    Parameters:
    uri - URI to process
    Returns:
    Last part of URI path.
  - public java.util.regex.Pattern patternize(Object stringy)
    
    Converts most things to a pattern. Closures are evaluated as well.
    Unwraps the following recursively until it gets to a pattern:
    - CharSequence including String and GString.
    - java.util.regex.Pattern.
    - Groovy Closures.
    - java.util.concurrent.Callable
    - java.util.Optional
    - Provider
    - java.util.function.Supplier
    Parameters:
    stringy - An object that can be converted to a pattern or a closure that can be evaluated to something that can be converted to a pattern.
    Returns:
    A pattern object
    Since:
    5.0
  - public java.util.List<java.util.regex.Pattern> patternize(java.util.Collection<?> stringyThings)
    
    Converts a collection of most things to a list of regex patterns. Closures are evaluated as well.
    Parameters:
    stringyThings - Iterable list of objects that can be converted to patterns, including closure that can be evaluated into objects that can be converted to patterns.
    Returns:
    A list of patterns
    Since:
    5.0
  - public java.util.List<java.util.regex.Pattern> patternizeDropNull(java.util.Collection<?> stringyThings)
    
    Like patternize, but drops any nulls, or empty instances of Provider and java.util.Optional.
    Parameters:
    stringyThings - Iterable list of objects that can be converted to patterns, including closure that can be evaluated into objects that can be converted to patterns.
    Returns:
    A list of patterns
    Since:
    5.0
  - public java.util.regex.Pattern patternizeOrNull(Object stringy)
    
    Like patternize, but returns null rather than throwing an exception, when item is null, an empty {
    Link:
    Provider} or an empty java.util.Optional.
    
    Parameters:
    stringy - An object that can be converted to a pattern or a closure that can be evaluated to something that can be converted to a pattern.
    Returns:
    Pattern or null
    Since:
    5.0
  - public Provider<byte[]> provideByteArray(Object src)
    
    Like provideByteArray(Object), but lazy-evaluates the value..
    Parameters:
    src - Anything providing a byte[], a Byte[], or a string in some form other. Usual recursive unwrapping will occur, before evaluation. Empty wrappers and null are not accepted.
    Returns:
    A provider to byte[]
    Since:
    5.0
  - public Provider<byte[]> provideByteArrayOrNull(Object src)
    
    Like provideByteArrayOrNull(Object), but lazy-evaluates the value..
    Parameters:
    src - Anything providing a byte[], a Byte[], or a string in some form other. Usual recursive unwrapping will occur, before evaluation.
    Returns:
    A provider to byte[]. Empty wrappers and null will result in an empty provider.
    Since:
    5.0
  - public Provider<String> provideCaseConversion(CaseFormats inputFormat, CaseFormats outputFormat, Object stringy)
    
    Converts a string in one format to another.
    Parameters:
    inputFormat - Input case format.
    outputFormat - Output case format.
    stringy - Object to convert
    Returns:
    Provider to a transformed string.
  - public Provider<java.util.regex.Pattern> providePattern(Object stringy)
    
    Like patternize, but does not immediately evaluate the passed parameter. The latter is only done when the provider is resolved.
    Parameters:
    stringy - An object that can be converted to a pattern or a closure that can be evaluated to something that can be converted to a pattern.
    Returns:
    A provider to a regex pattern.
    Since:
    5.0
  - public Provider<java.util.regex.Pattern> providePatternOrNull(Object stringy)
    
    Like patternizeOrNull(Object), but does not evaluate the passed parameter immediately.
    Parameters:
    stringy - An object that can be converted to a pattern or a closure that can be evaluated to something that can be converted to a pattern.
    Returns:
    A provider to a regex pattern. Can be empty.
    Since:
    5.0
  - public Provider<String> provideString(Object stringy)
    
    Like stringize, but does not immediately evaluate the passed parameter. The latter is only done when the provider is resolved.
    Parameters:
    stringy - An object that can be converted to a string or a closure that can be evaluated to something that can be converted to a string.
    Returns:
    A provider to a string.
    Since:
    5.0
  - public Provider<String> provideStringOrNull(Object stringy)
    
    Like stringizeOrNull(Object), but does not evaluate the passed parameter immediately.
    Parameters:
    stringy - Anything convertible to a string.
    Returns:
    Provider to a string. Can be empty.
    Since:
    5.0
  - public Provider<java.util.List<String>> provideStrings(java.util.Collection<Object> stringyThings)
    
    Provides a list of items to be converted to strings.
    Parameters:
    stringyThings - Anything convertible to a string.
    Returns:
    Provider to a string list. The provider will not be empty, but the underlying list could be.
    Since:
    5.5
  - public Provider<java.util.List<String>> provideStringsDropNull(java.util.Collection<Object> stringyThings)
    
    Provides a list of items to be converted to strings dropping anything evaluating to null
    Parameters:
    stringyThings - Anything convertible to a string.
    Returns:
    Provider to a string list. The provider will not be empty, but the underlying list could be.
    Since:
    5.5
  - public Provider<String> provideTextFromResource(String resourcePath)
    
    Lazy-loads text from a resource file.
    throws:
    org.gradle.api.resources.ResourceException
    
    Parameters:
    resourcePath - Resource path.
    Returns:
    Provider to text
    Since:
    5.0
  - public Provider<URI> provideUri(Object uriThingy)
    
    Similar to urize(Object), but does not evaluate the parameter immediately, only when the provider is resolved.
    Parameters:
    uriThingy - Anything that could be converted to a URI
    Returns:
    Provider to a URI
    Since:
    5.0
  - public Provider<java.util.Map<String, String>> provideValues(java.util.Map<String, ?> props)
    
    Similar to stringizeValues, but does not evaluate the parameter immediately, only when the provider is resolved.
    Parameters:
    props - A map that is keyed on strings, but for which the values can be converted to strings using stringize(Object).
    Returns:
    A provider to a lazy-resolved map.
    Since:
    5.0
  - public Provider<java.util.Map<String, String>> provideValues(Provider<java.util.Map<String, Object>> props)
    
    Similar to stringizeValues, but does not evaluate the parameter immediately, only when the provider is resolved.
    Parameters:
    props - A provider to a map that is keyed on strings, but for which the values can be converted to strings using stringize(Object).
    Returns:
    A provider to a lazy-resolved map.
    Since:
    5.0
  - public Provider<java.util.Map<String, String>> provideValuesDropNull(java.util.Map<String, ?> props)
    
    Similar to stringizeValuesDropNull(Map), but does not evaluate the parameter immediately, only when the provider is resolved.
    Parameters:
    props - A map that is keyed on strings, but for which the values can be converted to strings using stringize(Object).
    Returns:
    A provider to a lazy-resolved map.
    Since:
    5.0
  - public Provider<java.util.Map<String, String>> provideValuesDropNull(Provider<java.util.Map<String, Object>> props)
    
    Similar to stringizeValuesDropNull(Map), but does not evaluate the parameter immediately, only when the provider is resolved.
    Parameters:
    props - A provider to a map that is keyed on strings, but for which the values can be converted to strings using stringize(Object).
    Returns:
    A provider to a lazy-resolved map.
    Since:
    5.0
  - public Provider<java.util.Map<String, String>> provideValuesKeepNull(java.util.Map<String, ?> props)
    
    Lazy-evaluate the map. If the values are null or contain empty providers, the resulting value will be kept with a null value.
    Parameters:
    props - A map that is keyed on strings, but for which the values can be converted to strings using stringize(Object).
    Returns:
    A provider to a lazy-resolved map.
    Since:
    5.4
  - public Provider<java.util.Map<String, String>> provideValuesKeepNull(Provider<java.util.Map<String, Object>> props)
    
    Lazy-evaluate the map. If the values are null or contain empty providers, the resulting value will be kept with a null value.
    Parameters:
    props - A map that is keyed on strings, but for which the values can be converted to strings using stringize(Object).
    Returns:
    A provider to a lazy-resolved map.
    Since:
    5.0
  - public URI safeUri(URI uri)
    
    Create a URI where the user/password is masked out.
    Parameters:
    uri - Original URI
    Returns:
    URI with no credentials.
  - public String stringize(Object stringy)
    
    Converts most things to a string. Closures are evaluated as well.
    Converts collections of the following recursively until it gets to a string:
    - CharSequence including String and GString.
    - File.
    - java.nio.file.Path is it is associated with the default provider
    - URLs and URIs.
    - Groovy Closures.
    - java.util.concurrent.Callable
    - java.util.Optional
    - Provider
    - java.util.function.Supplier
    - TextResource
    Parameters:
    stringy - An object that can be converted to a string or a closure that can be evaluated to something that can be converted to a string.
    Returns:
    A string object
  - public java.util.List<String> stringize(java.util.Collection<?> stringyThings)
    
    Converts a collection of most things to a list of strings. Closures are evaluated as well.
    Parameters:
    stringyThings - Iterable list of objects that can be converted to strings, including closure that can be evaluated into objects that can be converted to strings.
    Returns:
    A list of strings
  - public java.util.List<String> stringizeDropNull(java.util.Collection<?> stringyThings)
    
    Like stringize, but drops any nulls, or empty instances of Provider and java.util.Optional.
    Parameters:
    stringyThings
    Returns:
    A list of strings
  - public String stringizeOrNull(Object stringy)
    
    Like stringize, but returns null rather than throwing an exception, when item is null, an empty {
    Link:
    Provider} or an empty java.util.Optional.
    
    Parameters:
    stringy
    Returns:
    string or null
  - public java.util.Map<String, String> stringizeValues(java.util.Map<String, ?> props)
    
    Evaluates a map of objects to a map of strings.
    Anything value that can be evaluated by stringize is evaluated
    Parameters:
    props - Map that will be evaluated
    Returns:
    Converted Map<String,String>
  - public java.util.Map<String, String> stringizeValuesDropNull(java.util.Map<String, ?> props)
    
    Like stringizeValues(Map), but drops the key, if the corresponding value is null or an empty Provider or java.util.Optional.
    subce:
    5.0
    
    Parameters:
    props - Map that wil be evaluated
    Returns:
    Converted map. Can be empty, but never null.
  - public void updateStringProperty(Property<String> provider, Object stringy)
    
    Updates a Property<String>. THis provides a more powerful way than Property.set.
    Parameters:
    provider - String property
    stringy - Objexct that is a string or can be converted to a string.
  - public URI urize(Object uriThingy)
    
    Attempts to convert object to a URI.
    Converts collections of the following recursively until it gets to a file:
    - CharSequence including String and GString.
    - File.
    - java.nio.file.Path if it is associated with the default provider
    - URLs and URIs.
    - Groovy Closures.
    - java.util.concurrent.Callable.
    - Provider.
    - java.util.concurrent.Callable
    - java.util.Optional
    - java.util.function.Supplier
    Parameters:
    uriThingy - Anything that could be converted to a URI
    Returns:
    URI object

Summary:
Method

| Detail:
Method

Groovy Documentation

[Java] Interface StringTools

Methods Summary

Method Detail

public String caseConversion(CaseFormats inputFormat, CaseFormats outputFormat, Object stringy)

public String hashUri(URI uri)

public String loadTextFromResource(String resourcePath)

public byte[] makeByteArray(Object src)

public byte[] makeByteArrayOrNull(Object src)

public String packageNameFromUri(URI uri)

public java.util.regex.Pattern patternize(Object stringy)

public java.util.List<java.util.regex.Pattern> patternize(java.util.Collection<?> stringyThings)

public java.util.List<java.util.regex.Pattern> patternizeDropNull(java.util.Collection<?> stringyThings)

public java.util.regex.Pattern patternizeOrNull(Object stringy)

public Provider<byte[]> provideByteArray(Object src)

public Provider<byte[]> provideByteArrayOrNull(Object src)

public Provider<String> provideCaseConversion(CaseFormats inputFormat, CaseFormats outputFormat, Object stringy)

public Provider<java.util.regex.Pattern> providePattern(Object stringy)

public Provider<java.util.regex.Pattern> providePatternOrNull(Object stringy)

public Provider<String> provideString(Object stringy)

public Provider<String> provideStringOrNull(Object stringy)

public Provider<java.util.List<String>> provideStrings(java.util.Collection<Object> stringyThings)

public Provider<java.util.List<String>> provideStringsDropNull(java.util.Collection<Object> stringyThings)

public Provider<String> provideTextFromResource(String resourcePath)

public Provider<URI> provideUri(Object uriThingy)

public Provider<java.util.Map<String, String>> provideValues(java.util.Map<String, ?> props)

public Provider<java.util.Map<String, String>> provideValues(Provider<java.util.Map<String, Object>> props)

public Provider<java.util.Map<String, String>> provideValuesDropNull(java.util.Map<String, ?> props)

public Provider<java.util.Map<String, String>> provideValuesDropNull(Provider<java.util.Map<String, Object>> props)

public Provider<java.util.Map<String, String>> provideValuesKeepNull(java.util.Map<String, ?> props)

public Provider<java.util.Map<String, String>> provideValuesKeepNull(Provider<java.util.Map<String, Object>> props)

public URI safeUri(URI uri)

public String stringize(Object stringy)

public java.util.List<String> stringize(java.util.Collection<?> stringyThings)

public java.util.List<String> stringizeDropNull(java.util.Collection<?> stringyThings)

public String stringizeOrNull(Object stringy)

public java.util.Map<String, String> stringizeValues(java.util.Map<String, ?> props)

public java.util.Map<String, String> stringizeValuesDropNull(java.util.Map<String, ?> props)

public void updateStringProperty(Property<String> provider, Object stringy)

public URI urize(Object uriThingy)