ValueConverter (RVPF-Core API Documentation)

Object
- ValueConverter

```
@Immutable
public final class ValueConverter
extends Object
```
Value converter.
This is a utility class to help with the conversion of values. It contains only static methods and constant attributes.

Field Summary

Fields
Modifier and Type Field and Description

static int ONE_MEBIBYTE
One mebibyte (SI).

Fields
Modifier and Type	Field and Description
`static int`	`ONE_MEBIBYTE` One mebibyte (SI).

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`canonicalizePath(String path)` Canonicalize a path.
`static Optional<String>`	`canonicalizeString(Optional<String> text)` Canonicalizes a text string.
`static boolean`	`convertToBoolean(String type, String name, Optional<String> valueToConvert, boolean defaultValue)` Converts a named boolean value, providing a default.
`static Optional<Boolean>`	`convertToBoolean(String type, String name, Optional<String> valueToConvert, Optional<Boolean> defaultValue)` Converts a named boolean value, providing a default.
`static double`	`convertToDouble(String type, String name, Optional<String> valueToConvert, double defaultValue)` Converts a named double value, providing a default.
`static Optional<Double>`	`convertToDouble(String type, String name, Optional<String> valueToConvert, Optional<Double> defaultValue)` Converts a named double value, providing a default.
`static int`	`convertToInt(String type, String name, Optional<String> valueToConvert, int defaultValue)` Converts a named int value, providing a default.
`static Optional<Integer>`	`convertToInteger(String type, String name, Optional<String> valueToConvert, Optional<Integer> defaultValue)` Converts a named int value, providing a default.
`static long`	`convertToLong(String type, String name, Optional<String> valueToConvert, long defaultValue)` Converts a named long value, providing a default.
`static Optional<Long>`	`convertToLong(String type, String name, Optional<String> valueToConvert, Optional<Long> defaultValue)` Converts a named long value, providing a default.
`static boolean`	`isCanonical(Optional<String> text)` Asks if a text has a canonical form.
`static boolean`	`isFalse(String value)` Asks if a value matches the 'false' pattern.
`static boolean`	`isTrue(String value)` Asks if a value matches the 'true' pattern.
`static long`	`roundToMebibytes(long bytes)` Rounds bytes to mebibytes.
`static String[]`	`splitFields(String fields)` Split fields separated by comma or spaces.
`static String[]`	`splitFields(String fields, int max)` Split fields separated by comma or spaces.
`static Integer`	`toInteger(boolean value)` Converts a boolean to an Integer object.
`static Pattern`	`wildToPattern(String wild)` Converts a String allowed to contain wild characters to a Pattern.

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

Field Detail
- ONE_MEBIBYTE
```
public static final int ONE_MEBIBYTE
```
  One mebibyte (SI).
  
  See Also:
  
  Constant Field Values

Method Detail

canonicalizePath

@Nonnull
 @CheckReturnValue
public static String canonicalizePath(@Nonnull
                                                                    String path)
                                                             throws IOException

Canonicalize a path.

Makes the path canonical. On Windows, replaces the back slashes with forward slashes.

Parameters:: path - The path.
Returns:: The canonicalized path.
Throws:: IOException - On failure.

canonicalizeString
```
@Nonnull
 @CheckReturnValue
public static Optional<String> canonicalizeString(@Nonnull
                                                                                Optional<String> text)
```
Canonicalizes a text string.
Uses Unicode canonical decomposition followed by canonical composition to ensure a consistent text representation.

Parameters:

text - The optional text string.

Returns:

The canonicalized text string (empty on missing text)..

convertToBoolean

@CheckReturnValue
public static boolean convertToBoolean(@Nonnull
                                                          String type,
                                                          @Nonnull
                                                          String name,
                                                          @Nonnull
                                                          Optional<String> valueToConvert,
                                                          boolean defaultValue)

Converts a named boolean value, providing a default.

Parameters:: type - The type of value (for logging purpose).; name - The name of the value (for logging purpose).; valueToConvert - The value to convert (may be empty).; defaultValue - The default value.
Returns:: The converted value or the provided default.

convertToBoolean

@Nonnull
 @CheckReturnValue
public static Optional<Boolean> convertToBoolean(@Nonnull
                                                                               String type,
                                                                               @Nonnull
                                                                               String name,
                                                                               @Nonnull
                                                                               Optional<String> valueToConvert,
                                                                               @Nonnull
                                                                               Optional<Boolean> defaultValue)

Converts a named boolean value, providing a default.

The following values will be interpreted as true (ignoring case):

""
"1"
"TRUE"
"YES"
"ON"
"T"
"Y"

The following values will be interpreted as false (ignoring case):

"0"
"FALSE"
"NO"
"OFF"
"F"
"N"

If the value is null or does not match one of the recognized values, the default will be returned.

Parameters:: type - The type of value (for logging purpose).; name - The name of the value (for logging purpose).; valueToConvert - The value to convert (may be empty).; defaultValue - The default value (may be empty).
Returns:: The converted value or the provided default (may be empty).