Value (SIRIUS kernel 12.0-rc9 API)

java.lang.Object
- sirius.kernel.commons.Value

```
public class Value
extends Object
```
Provides a generic wrapper for a value which is read from an untyped context like HTTP parameters.
It supports elegant null handling and type conversions.

Field Summary

Fields
Modifier and Type Field and Description

static Value EMPTY
Represents an empty value which contains null as data.

Fields
Modifier and Type	Field and Description
`static Value`	`EMPTY` Represents an empty value which contains `null` as data.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`afterFirst(String separator)` Returns the substring of the internal value starting right after the first occurrence of the given separator.
`String`	`afterLast(String separator)` Returns the substring of the internal value starting right after the last occurrence of the given separator.
`Value`	`append(String separator, Object value)` Returns a value which wraps `this + separator + value` If the current value is empty, the given value is returned (without the separator).
`boolean`	`asBoolean()` Boilerplate method for `asBoolean(false)`
`boolean`	`asBoolean(boolean defaultValue)` Converts the wrapped value to a `boolean` or returns the given `defaultValue` if no conversion is possible.
`double`	`asDouble(double defaultValue)` Returns the double value for the wrapped value or `defaultValue` if the wrapped value isn't a double and cannot be converted to one.
`<E extends Enum<E>> E`	`asEnum(Class<E> clazz)` Converts the wrapped value to an enum constant of the given `clazz`.
`Instant`	`asInstant(Instant defaultValue)` Returns the wrapped value as `Instant` or `defaultValue` if the wrapped value cannot be converted.
`Instant`	`asInstantOfEpochMillis(Instant defaultValue)` Converts the wrapped number into an `Instant` by assuming the number represents a "unix timestamp" in milliseconds.
`Instant`	`asInstantOfEpochSeconds(Instant defaultValue)` Converts the wrapped number into an `Instant` by assuming the number represents a "unix timestamp" in seconds.
`int`	`asInt(int defaultValue)` Returns the int value for the wrapped value or `defaultValue` if the wrapped value isn't an integer and cannot be converted to one.
`LocalDate`	`asLocalDate(LocalDate defaultValue)` Returns the wrapped value as `LocalDate` or `defaultValue` if the wrapped value cannot be converted.
`LocalDateTime`	`asLocalDateTime(LocalDateTime defaultValue)` Returns the wrapped value as `LocalDateTime` or `defaultValue` if the wrapped value cannot be converted.
`LocalDateTime`	`asLocalDateTimeOfEpochMillis(LocalDateTime defaultValue)` Converts the wrapped number into `LocalDateTime` by assuming the number represents a "unix timestamp" in milliseconds.
`LocalDateTime`	`asLocalDateTimeOfEpochSeconds(LocalDateTime defaultValue)` Converts the wrapped number into `LocalDateTime` by assuming the number represents a "unix timestamp" in seconds.
`LocalTime`	`asLocalTime(LocalTime defaultValue)` Returns the wrapped value as `LocalTime` or `defaultValue` if the wrapped value cannot be converted.
`long`	`asLong(long defaultValue)` Returns the long value for the wrapped value or `defaultValue` if the wrapped value isn't a long and cannot be converted to one.
`<T> Optional<T>`	`asOptional(Class<T> type)` Boilerplate for `Optional.ofNullable(get(type, null))`.
`Optional<Integer>`	`asOptionalInt()` Returns the internal value wrapped as Optional while expecting it to be an integer number.
`Optional<String>`	`asOptionalString()` Returns the internal value wrapped as Optional.
`String`	`asRomanNumeral(int defaultValue)` Tries to convert the wrapped value to a roman numeral representation This only works if the wrapped value can be converted to `int` and is >0 and <4000.
`String`	`asSmartRoundedString()` Returns the wrapped data converted to a string like `asString()` while "smart rounding" (`NLS.smartRound(double)` `Double` and `BigDecimal` values.
`String`	`asString()` Returns the wrapped data converted to a string or `""` if the wrapped value is `null` The conversion method used is `NLS.toMachineString(Object)`
`String`	`asString(String defaultValue)` Returns the wrapped data converted to a string or `defaultValue` if the wrapped value is `null` The conversion method used is `NLS.toMachineString(Object)`
`ZonedDateTime`	`asZonedDateTime(ZonedDateTime defaultValue)` Returns the wrapped value as `ZonedDateTime` or `defaultValue` if the wrapped value cannot be converted.
`String`	`beforeFirst(String separator)` Returns the substring of the internal value containing everything up to the first occurrence of the given separator.
`String`	`beforeLast(String separator)` Returns the substring of the internal value containing everything up to the last occurrence of the given separator.
`<T> T`	`coerce(Class<T> targetClazz, T defaultValue)` Converts or casts the wrapped object to the given `targetClazz`
`boolean`	`contains(String needle)` Checks if the given value is filled and contains the given needle in its string representation
`String`	`eat(int maxNumberOfCharacters)` Cuts and returns the first n given characters of the string representation of this value.
`boolean`	`endsWith(String value)` Checks if the string representation of the wrapped value ends with the given string.
`boolean`	`equals(Object other)`
`boolean`	`equalsIgnoreCase(Object otherString)` Determines if the string representation of the wrapped value is equal to the string representation of the given object.
`Value`	`first()` If the underlying data is a `Collection` this will return the first element wrapped as value.
`Object`	`get()` Returns the wrapped object
`<V> V`	`get(Class<V> clazz, V defaultValue)` Returns the wrapped value if it is an instance of the given clazz or the `defaultValue` otherwise.
`Object`	`get(Object defaultValue)` Returns the internal data or the given `defaultValue`
`Amount`	`getAmount()` Returns the `Amount` for the wrapped value.
`BigDecimal`	`getBigDecimal()` Returns the `BigDecimal` value for the wrapped value or `null` if the wrapped value isn't a BigDecimal and cannot be converted to one.
`BigDecimal`	`getBigDecimal(BigDecimal defaultValue)` Returns the `BigDecimal` value for the wrapped value or `defaultValue` if the wrapped value isn't a BigDecimal and cannot be converted to one.
`<E extends Enum<E>> Optional<E>`	`getEnum(Class<E> clazz)` Converts the wrapped value to an enum constant of the given `clazz`.
`Integer`	`getInteger()` Returns the int value for the wrapped value or `null` if the wrapped value isn't an integer and cannot be converted to one.
`Long`	`getLong()` Returns the long value for the wrapped value or `null` if the wrapped value isn't a long and cannot be converted to one.
`String`	`getString()` Returns the data converted to a string, or `null` if the wrapped value is null The conversion method used is `NLS.toMachineString(Object)`
`int`	`hashCode()`
`Value`	`ifFilled(Consumer<Value> consumer)` Calls the given consumer with `this` if the value is filled.
`Value`	`ignore(String... ignoredValues)` Returns a new `Value` which will be empty its value equals one of the given ignored values.
`boolean`	`in(Object... objects)` Determines if the wrapped value is equal to one of the given objects.
`static Value`	`indexOf(int index, Collection<?> collection)` Returns the n-th (index-th) element of the given collection.
`static Value`	`indexOf(int index, Object[] array)` Returns the n-th (index-th) element of the given array.
`boolean`	`is(Class<?>... classes)` Checks if the value implements one of the given classes.
`boolean`	`isEmptyString()` Determines if the wrapped value is an empty string.
`boolean`	`isFilled()` Determines if the wrapped value is not null.
`boolean`	`isNull()` Determines if the wrapped value is `null`
`boolean`	`isNumeric()` Checks if the current value is numeric (integer or double).
`String`	`left(int length)` Returns the first N (`length`) characters of the string representation of the wrapped value.
`int`	`length()` Returns the length of the string representation of the wrapped value.
`<R> Optional<R>`	`map(Function<Value,R> mapper)` Returns an optional value computed by the given mapper.
`boolean`	`notIn(Object... objects)` Determines if the wrapped value isn't equal to any of the given objects.
`static Value`	`of(Object data)` Creates a new wrapper for the given data.
`Value`	`prepend(String separator, Object value)` Returns a value which wraps `value + separator + this` If the current value is empty, the given value is returned (without the separator).
`Value`	`regExReplace(String pattern, String replacement)` Replaces the given regular expression `pattern` with the given replacement in the string representation of the wrapped object
`Value`	`replace(String pattern, String replacement)` Replaces the given `pattern` with the given replacement in the string representation of the wrapped object
`Value`	`replaceEmptyWith(Object replacement)` Returns a new `Value` which will wrap the given value, if the current value is empty.
`Value`	`replaceIfEmpty(Supplier<?> supplier)` Returns a new `Value` which will wrap the value produced by the given supplier, if the current value is empty.
`String`	`right(int length)` Returns the last N (`length`) characters of the string representation of the wrapped value.
`boolean`	`startsWith(String value)` Checks if the string representation of the wrapped value starts with the given string.
`String`	`substring(int startIndex, int endIndex)` Returns a substring of the string representation of the wrapped value.
`String`	`toLowerCase()` Returns an lowercase version of the string representation of the wrapped value.
`String`	`toString()`
`String`	`toUpperCase()` Returns an uppercase version of the string representation of the wrapped value.
`Value`	`translate()` Returns a `Value` containing a translated value using the string representation of the wrapped value as key.
`Value`	`translate(String lang)` Returns a `Value` containing a translated value using the string representation of the wrapped value as key.
`String`	`trim()` Returns a trimmed version of the string representation of the wrapped value.

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

- Field Detail
  - EMPTY
```
public static final Value EMPTY
```
    Represents an empty value which contains null as data.
- Method Detail
  - of
```
@Nonnull
public static Value of(@Nullable
                                Object data)
```
    Creates a new wrapper for the given data.
    
    Parameters:
    
    data - the object wrap
    
    Returns:
    
    the newly created value which wraps the given data object
  - indexOf
```
@Nonnull
public static Value indexOf(int index,
                                     @Nullable
                                     Collection<?> collection)
```
    Returns the n-th (index-th) element of the given collection.
    
    Parameters:
    
    index - the zero based index of the element to fetch
    
    collection - the collection to pick the element from
    
    Returns:
    
    the element at index wrapped as Value or an empty value if the collection is null or if the index is outside of the collections bounds
  - indexOf
```
@Nonnull
public static Value indexOf(int index,
                                     @Nullable
                                     Object[] array)
```
    Returns the n-th (index-th) element of the given array.
    
    Parameters:
    
    index - the zero based index of the element to fetch
    
    array - the array to pick the element from
    
    Returns:
    
    the element at index wrapped as Value or an empty value if the array is null or if the index is outside of the arrays bounds
  - isNull
```
public boolean isNull()
```
    Determines if the wrapped value is null
    
    Returns:
    
    true if the wrapped value is null, false otherwise
  - isEmptyString
```
public boolean isEmptyString()
```
    Determines if the wrapped value is an empty string.
    
    Returns:
    
    true if the wrapped value is an empty string, false otherwise
  - contains
```
public boolean contains(String needle)
```
    Checks if the given value is filled and contains the given needle in its string representation
    
    Parameters:
    
    needle - the substring to search
    
    Returns:
    
    true if the given substring needle was found in the wrapped objects string representation, false otherwise
  - isFilled
```
public boolean isFilled()
```
    Determines if the wrapped value is not null.
    
    Returns:
    
    true if the wrapped value is neither null nor ""
  - ifFilled
```
public Value ifFilled(Consumer<Value> consumer)
```
    Calls the given consumer with this if the value is filled.
    
    Parameters:
    
    consumer - the consumer to call with this object if it is filled
    
    Returns:
    
    the value itself for fluent method calls
  - ignore
```
@Nonnull
public Value ignore(String... ignoredValues)
```
    Returns a new Value which will be empty its value equals one of the given ignored values.
    
    Parameters:
    
    ignoredValues - the list of values which will be replaced by an empty value
    
    Returns:
    
    a Value which is empty if the currently wrapped value equals to one of the given values. Otherwise the current value is returned.
  - replaceEmptyWith
```
@Nonnull
public Value replaceEmptyWith(@Nullable
                                       Object replacement)
```
    Returns a new Value which will wrap the given value, if the current value is empty. Otherwise, the current value will be returned.
    
    Parameters:
    
    replacement - the value which is used as replacement if this value is empty
    
    Returns:
    
    a new Value wrapping the given value or the current value if this is not empty.
  - replaceIfEmpty
```
@Nonnull
public Value replaceIfEmpty(@Nonnull
                                     Supplier<?> supplier)
```
    Returns a new Value which will wrap the value produced by the given supplier, if the current value is empty. Otherwise, the current value will be returned.
    
    Parameters:
    
    supplier - the supplier used to compute a replacement value if this value is empty
    
    Returns:
    
    a new Value wrapping the produced value of the given supplier or the current value if this is not empty.
  - map
```
@Nonnull
public <R> Optional<R> map(@Nonnull
                                    Function<Value,R> mapper)
```
    Returns an optional value computed by the given mapper. If this value is empty the mapper will not be called, but an empty optional will be returned.
    
    Type Parameters:
    
    R - the type of the desired result
    
    Parameters:
    
    mapper - the function used to convert the value into the desired object
    
    Returns:
    
    an Optional object wrapping the result of the computation or an empty Optional, if the value wasn't filled
  - asOptional
```
@Nonnull
public <T> Optional<T> asOptional(@Nonnull
                                           Class<T> type)
```
    Boilerplate for Optional.ofNullable(get(type, null)).
    Returns the internal value wrapped as Optional.
    
    Type Parameters:
    
    T - the expected type of the contents of this value
    
    Parameters:
    
    type - the desired type of the data
    
    Returns:
    
    the internal value (casted to the given type) wrapped as Optional or an empty Optional if the value was empty or the cast failed.
  - asOptionalInt
```
public Optional<Integer> asOptionalInt()
```
    Returns the internal value wrapped as Optional while expecting it to be an integer number.
    If the value is empty or not an integer, an empty Optional will be returned.
    
    Returns:
    
    the internal value wrapped as Optional or an empty Optional if the value is not filled or non-integer
  - asOptionalString
```
public Optional<String> asOptionalString()
```
    Returns the internal value wrapped as Optional.
    If the value is empty, an empty Optional will be returned.
    
    Returns:
    
    the internal value wrapped as Optional or an empty Optional if the value is not filled
  - append
```
@Nonnull
public Value append(@Nullable
                             String separator,
                             @Nullable
                             Object value)
```
    Returns a value which wraps this + separator + value
    If the current value is empty, the given value is returned (without the separator). If the given value is an empty string, the current value is returned (without the separator).
    
    Parameters:
    
    separator - the separator to be put in between the two. If the given value is null, "" is assumed
    
    value - the value to be appended to the current value.
    
    Returns:
    
    a Value representing the current value appended with the given value and separated with the given separator
  - prepend
```
@Nonnull
public Value prepend(@Nullable
                              String separator,
                              @Nullable
                              Object value)
```
    Returns a value which wraps value + separator + this
    If the current value is empty, the given value is returned (without the separator). If the given value is an empty string, the current value is returned (without the separator).
    
    Parameters:
    
    separator - the separator to be put in between the two. If the given value is null, "" is assumed
    
    value - the value to be appended to the current value.
    
    Returns:
    
    a Value representing the given value appended with the current value and separated with the given separator
  - eat
```
@Nonnull
public String eat(int maxNumberOfCharacters)
```
    Cuts and returns the first n given characters of the string representation of this value.
    Note: This modifies the internal state of this value, since the number of characters is cut from the string representation of the current object and the remaining string is stored as new internal value.
    If the wrapped value is empty, "" is returned. If the string representation of the wrapped object is shorter than maxNumberOfCharacters, the remaining string is returned and the internal value is set to null.
    This can be used to cut a string into sub strings of a given length:
```
 
             Value v = Value.of("This is a long string...");
             while(v.isFilled()) {
                 System.out.println("Up to 5 chars of v: "+v.eat(5));
             }
 
 
```
    Parameters:
    
    maxNumberOfCharacters - the max length of the string to cut from the wrapped value
    
    Returns:
    
    the first maxNumberOfCharacters of the wrapped values string representation, or less if it is shorter. Returns "" if the wrapped value is empty.
  - isNumeric
```
public boolean isNumeric()
```
    Checks if the current value is numeric (integer or double).
    
    Returns:
    
    true if the wrapped value is either a Number or an Amount or if it is a string which can be converted to a long or double
  - get
```
@Nullable
public Object get()
```
    Returns the wrapped object
    
    Returns:
    
    the wrapped object of this Value
  - get
```
@Nonnull
public Object get(@Nonnull
                           Object defaultValue)
```
    Returns the internal data or the given defaultValue
    
    Parameters:
    
    defaultValue - the value to use if the inner value is null
    
    Returns:
    
    the wrapped value or the given defaultValue if the wrapped value is null
  - first
```
@Nonnull
public Value first()
```
    If the underlying data is a Collection this will return the first element wrapped as value. Otherwise this is returned.
    
    Returns:
    
    the first element of the underlying collection or the element itself wrapped as value
  - coerce
```
public <T> T coerce(Class<T> targetClazz,
                    T defaultValue)
```
    Converts or casts the wrapped object to the given targetClazz
    
    Type Parameters:
    
    T - the type to coerce to
    
    Parameters:
    
    targetClazz - the desired class to which the wrapped value should be converted or casted.
    
    defaultValue - the default value if the wrapped object is empty or cannot be cast to the given target.
    
    Returns:
    
    a converted instance of type targetClass or the defaultValue if no conversion was possible
    
    Throws:
    
    IllegalArgumentException - if the given targetClazz is unknown
  - get
```
public <V> V get(Class<V> clazz,
                 V defaultValue)
```
    Returns the wrapped value if it is an instance of the given clazz or the defaultValue otherwise.
    
    Type Parameters:
    
    V - the expected type of the wrapped value
    
    Parameters:
    
    clazz - the desired class of the return type
    
    defaultValue - the value which is returned if the wrapped value is not assignable to the given class.
    
    Returns:
    
    the wrapped value if the given clazz is assignable from wrapped values class or the defaultValue otherwise
  - getString
```
@Nullable
public String getString()
```
    Returns the data converted to a string, or null if the wrapped value is null
    The conversion method used is NLS.toMachineString(Object)
    
    Returns:
    
    a string representation of the wrapped object or null if the wrapped value is null
  - asString
```
@Nonnull
public String asString(@Nonnull
                                String defaultValue)
```
    Returns the wrapped data converted to a string or defaultValue if the wrapped value is null
    The conversion method used is NLS.toMachineString(Object)
    
    Parameters:
    
    defaultValue - the value to use if the wrapped object was null
    
    Returns:
    
    a string representation of the wrapped object or defaultValue if the wrapped value is null
  - asString
```
@Nonnull
public String asString()
```
    Returns the wrapped data converted to a string or "" if the wrapped value is null
    The conversion method used is NLS.toMachineString(Object)
    
    Returns:
    
    a string representation of the wrapped object or "" if the wrapped value is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - asSmartRoundedString
```
@Nonnull
public String asSmartRoundedString()
```
    Returns the wrapped data converted to a string like asString() while "smart rounding" (NLS.smartRound(double) Double and BigDecimal values.
    This method behaves just like asString, except for Double and BigDecimal values where the output is "smart rounded". Therefore, 12.34 will be formatted as 12.34 but 1.000 will be formatted as 1
    
    Returns:
    
    a string representation of the wrapped object as generated by asString except for Double or BigDecimal values, which are "smart rounded".
    
    See Also:
    
    NLS.smartRound(double)
  - asBoolean
```
public boolean asBoolean(boolean defaultValue)
```
    Converts the wrapped value to a boolean or returns the given defaultValue if no conversion is possible.
    To convert a value, Boolean.parseBoolean(String) is used, where toString is called on all non-string objects.
    
    Parameters:
    
    defaultValue - the value to be used if the wrapped value cannot be converted to a boolean.
    
    Returns:
    
    true if the wrapped value is true or if the string representation of it is "true". Returns false otherwise, especially if the wrapped value is null
  - asBoolean
```
public boolean asBoolean()
```
    Boilerplate method for asBoolean(false)
    
    Returns:
    
    true if the wrapped value is true or if the string representation of it is "true". Returns false otherwise, especially if the wrapped value is null
  - asInt
```
public int asInt(int defaultValue)
```
    Returns the int value for the wrapped value or defaultValue if the wrapped value isn't an integer and cannot be converted to one.
    If the wrapped value is an Integer or BigDecimal, it is either directly returned or converted by calling BigDecimal.longValue().
    Otherwise Integer.parseInt(String) is called on the string representation of the wrapped value. If parsing fails, or if the wrapped value was null, the defaultValue will be returned.
    
    Parameters:
    
    defaultValue - the value to be used, if no conversion to int is possible.
    
    Returns:
    
    the wrapped value casted or converted to int or defaultValue if no conversion is possible.
  - asRomanNumeral
```
public String asRomanNumeral(int defaultValue)
```
    Tries to convert the wrapped value to a roman numeral representation This only works if the wrapped value can be converted to int and is >0 and <4000.
    
    Parameters:
    
    defaultValue - the value to be converted to roman numeral if the wrapped value can not be converted
    
    Returns:
    
    a roman numeral representation of either the wrapped value or the defaultValue. values >=4000 and <=0 are represented as an empty String
  - getInteger
```
@Nullable
public Integer getInteger()
```
    Returns the int value for the wrapped value or null if the wrapped value isn't an integer and cannot be converted to one.
    If the wrapped value is an Integer or BigDecimal, it is either directly returned or converted by calling BigDecimal.longValue().
    Otherwise Integer.parseInt(String) is called on the string representation of the wrapped value. If parsing fails, or if the wrapped value was null, null will be returned.
    
    Returns:
    
    the wrapped value casted or converted to Integer or null if no conversion is possible.
  - asLong
```
public long asLong(long defaultValue)
```
    Returns the long value for the wrapped value or defaultValue if the wrapped value isn't a long and cannot be converted to one.
    If the wrapped value is a Long, Integer or BigDecimal, it is either directly returned or converted by calling BigDecimal.longValue().
    Otherwise Long.parseLong(String) is called on the string representation of the wrapped value. If parsing fails, or if the wrapped value was null, the defaultValue will be returned.
    
    Parameters:
    
    defaultValue - the value to be used, if no conversion to long is possible.
    
    Returns:
    
    the wrapped value casted or converted to long or defaultValue if no conversion is possible.
  - getLong
```
@Nullable
public Long getLong()
```
    Returns the long value for the wrapped value or null if the wrapped value isn't a long and cannot be converted to one.
    If the wrapped value is a Long, Integer or BigDecimal, it is either directly returned or by calling BigDecimal.longValue().
    Otherwise Long.parseLong(String) is called on the string representation of the wrapped value. If parsing fails, or if the wrapped value was null, null will be returned.
    
    Returns:
    
    the wrapped value casted or converted to Long or null if no conversion is possible.
  - asDouble
```
public double asDouble(double defaultValue)
```
    Returns the double value for the wrapped value or defaultValue if the wrapped value isn't a double and cannot be converted to one.
    If the wrapped value is a Double, Long, Integer or BigDecimal, it is either directly returned or converted by calling BigDecimal.doubleValue().
    Otherwise Double.parseDouble(String) is called on the string representation of the wrapped value. If parsing fails, or if the wrapped value was null, the defaultValue will be returned.
    
    Parameters:
    
    defaultValue - the value to be used, if no conversion to double is possible.
    
    Returns:
    
    the wrapped value casted or converted to double or defaultValue if no conversion is possible.
  - asLocalDate
```
public LocalDate asLocalDate(LocalDate defaultValue)
```
    Returns the wrapped value as LocalDate or defaultValue if the wrapped value cannot be converted.
    If the wrapped value is an Instant, LocalDateTime, ZonedDateTime, Date, Calendar, java.sql.Date, Timestamp or long, it is converted to a LocalDate.
    
    Parameters:
    
    defaultValue - the value to be used, if no conversion is possible
    
    Returns:
    
    the wrapped value casted or converted to LocalDate or defaultValue if no conversion is possible.
  - asLocalDateTime
```
public LocalDateTime asLocalDateTime(LocalDateTime defaultValue)
```
    Returns the wrapped value as LocalDateTime or defaultValue if the wrapped value cannot be converted.
    If the wrapped value is an Instant, LocalDateTime, ZonedDateTime, Date, Calendar, java.sql.Date, Timestamp or long, it is converted to a LocalDateTime.
    
    Parameters:
    
    defaultValue - the value to be used, if no conversion is possible
    
    Returns:
    
    the wrapped value casted or converted to LocalDateTime or defaultValue if no conversion is possible.
  - asLocalTime
```
public LocalTime asLocalTime(LocalTime defaultValue)
```
    Returns the wrapped value as LocalTime or defaultValue if the wrapped value cannot be converted.
    If the wrapped value is an Instant, LocalDateTime, ZonedDateTime, Date, Calendar, java.sql.Date, Timestamp or long, it is converted to a LocalTime.
    
    Parameters:
    
    defaultValue - the value to be used, if no conversion is possible
    
    Returns:
    
    the wrapped value casted or converted to LocalTime or defaultValue if no conversion is possible.
  - asZonedDateTime
```
public ZonedDateTime asZonedDateTime(ZonedDateTime defaultValue)
```
    Returns the wrapped value as ZonedDateTime or defaultValue if the wrapped value cannot be converted.
    If the wrapped value is an Instant, LocalDateTime, ZonedDateTime, Date, Calendar, java.sql.Date, Timestamp or long, it is converted to a ZonedDateTime.
    
    Parameters:
    
    defaultValue - the value to be used, if no conversion is possible
    
    Returns:
    
    the wrapped value casted or converted to ZonedDateTime or defaultValue if no conversion is possible.
  - asInstant
```
public Instant asInstant(Instant defaultValue)
```
    Returns the wrapped value as Instant or defaultValue if the wrapped value cannot be converted.
    If the wrapped value is an Instant, LocalDateTime, ZonedDateTime, Date, Calendar, java.sql.Date, Timestamp or long, it is converted to an Instant.
    
    Parameters:
    
    defaultValue - the value to be used, if no conversion is possible
    
    Returns:
    
    the wrapped value casted or converted to Instant or defaultValue if no conversion is possible.
  - asInstantOfEpochSeconds
```
public Instant asInstantOfEpochSeconds(Instant defaultValue)
```
    Converts the wrapped number into an Instant by assuming the number represents a "unix timestamp" in seconds.
    
    Parameters:
    
    defaultValue - used if an invalid or non numeric value was found
    
    Returns:
    
    the Instant as determined by the wrapped timestamp value or defaultValue if no conversion was possible
  - asInstantOfEpochMillis
```
public Instant asInstantOfEpochMillis(Instant defaultValue)
```
    Converts the wrapped number into an Instant by assuming the number represents a "unix timestamp" in milliseconds.
    
    Parameters:
    
    defaultValue - used if an invalid or non numeric value was found
    
    Returns:
    
    the Instant as determined by the wrapped timestamp value or defaultValue if no conversion was possible
  - asLocalDateTimeOfEpochMillis
```
public LocalDateTime asLocalDateTimeOfEpochMillis(LocalDateTime defaultValue)
```
    Converts the wrapped number into LocalDateTime by assuming the number represents a "unix timestamp" in milliseconds.
    
    Parameters:
    
    defaultValue - used if an invalid or non numeric value was found
    
    Returns:
    
    the LocalDateTime as determined by the wrapped timestamp value or defaultValue if no conversion was possible
  - asLocalDateTimeOfEpochSeconds
```
public LocalDateTime asLocalDateTimeOfEpochSeconds(LocalDateTime defaultValue)
```
    Converts the wrapped number into LocalDateTime by assuming the number represents a "unix timestamp" in seconds.
    
    Parameters:
    
    defaultValue - used if an invalid or non numeric value was found
    
    Returns:
    
    the LocalDateTime as determined by the wrapped timestamp value or defaultValue if no conversion was possible
  - getBigDecimal
```
@Nonnull
public BigDecimal getBigDecimal(@Nonnull
                                         BigDecimal defaultValue)
```
    Returns the BigDecimal value for the wrapped value or defaultValue if the wrapped value isn't a BigDecimal and cannot be converted to one.
    If the wrapped value is a BigDecimal, Double, Long or Integer, it is either directly returned or converted by calling java.math.BigDecimal#valueOf.
    Otherwise BigDecimal.BigDecimal(String, java.math.MathContext) is called on the string representation of the wrapped value (with "," replaced to ".") and MathContext.UNLIMITED. If parsing fails, or if the wrapped value was null, the defaultValue will be returned.
    
    Parameters:
    
    defaultValue - the value to be used, if no conversion to BigDecimal is possible.
    
    Returns:
    
    the wrapped value casted or converted to BigDecimal or defaultValue if no conversion is possible.
  - getBigDecimal
```
@Nullable
public BigDecimal getBigDecimal()
```
    Returns the BigDecimal value for the wrapped value or null if the wrapped value isn't a BigDecimal and cannot be converted to one.
    If the wrapped value is a BigDecimal, Double, Long or Integer, it is either directly returned or converted by calling java.math.BigDecimal#valueOf.
    Otherwise BigDecimal.BigDecimal(String, java.math.MathContext) is called on the string representation of the wrapped value (with "," replaced to ".") and MathContext.UNLIMITED. If parsing fails, or if the wrapped value was null, the null will be returned.
    
    Returns:
    
    the wrapped value casted or converted to BigDecimal or null if no conversion is possible.
  - getAmount
```
public Amount getAmount()
```
    Returns the Amount for the wrapped value.
    If the wrapped value can be converted to a BigDecimal (getBigDecimal(java.math.BigDecimal), an Amount for the result is returned. Otherwise an empty Amount is returned.
    
    Returns:
    
    the wrapped value converted to Amount. The result might be an empty amount, if the wrapped value is null or if no conversion was possible.
    
    See Also:
    
    getBigDecimal(java.math.BigDecimal)
  - asEnum
```
public <E extends Enum<E>> E asEnum(Class<E> clazz)
```
    Converts the wrapped value to an enum constant of the given clazz.
    
    Type Parameters:
    
    E - the type of the enum
    
    Parameters:
    
    clazz - the type of the enum to use
    
    Returns:
    
    an enum constant of the given clazz with the same name as the wrapped value or null if no matching constant was found
  - getEnum
```
public <E extends Enum<E>> Optional<E> getEnum(Class<E> clazz)
```
    Converts the wrapped value to an enum constant of the given clazz.
    
    Type Parameters:
    
    E - to generic type of the enum
    
    Parameters:
    
    clazz - the enum to convert to
    
    Returns:
    
    the enum constant wrapped as optional or an empty optional if no conversion was possible.
  - startsWith
```
public boolean startsWith(@Nonnull
                          String value)
```
    Checks if the string representation of the wrapped value starts with the given string.
    
    Parameters:
    
    value - the substring with which the string representation must start
    
    Returns:
    
    true if the string representation starts with value, false otherwise. If the current value is empty, it is treated as ""
  - endsWith
```
public boolean endsWith(@Nonnull
                        String value)
```
    Checks if the string representation of the wrapped value ends with the given string.
    
    Parameters:
    
    value - the substring with which the string representation must end
    
    Returns:
    
    true if the string representation ends with value, false otherwise. If the current value is empty, it is treated as ""
  - trim
```
@Nonnull
public String trim()
```
    Returns a trimmed version of the string representation of the wrapped value.
    The conversion method used is asString(), therefore an empty value will yield "".
    
    Returns:
    
    a string representing the wrapped value without leading or trailing spaces.
  - left
```
@Nonnull
public String left(int length)
```
    Returns the first N (length) characters of the string representation of the wrapped value.
    If the wrapped value is null, "" will be returned. If the string representation is shorter than length, the whole string is returned.
    If length is negative, the string representation without the first N (length) characters is returned. If the string representation is too short, "" is returned.
    
    Parameters:
    
    length - the number of characters to return or to omit (if length is negative)
    
    Returns:
    
    the first N characters (or less if the string representation of the wrapped value is shorter) or the string representation without the first N characters (or "" if the representation is too short) if length is negative. Returns "" if the wrapped value is null
  - right
```
@Nonnull
public String right(int length)
```
    Returns the last N (length) characters of the string representation of the wrapped value.
    If the wrapped value is null, "" will be returned. If the string representation is shorter than length, the whole string is returned.
    If length is negative, the string representation without the last N (length) characters is returned. If the string representation is too short, "" is returned.
    
    Parameters:
    
    length - the number of characters to return or to omit (if length is negative)
    
    Returns:
    
    the last N characters (or less if the string representation of the wrapped value is shorter) or the string representation without the last N characters (or "" if the representation is too short) if length is negative. Returns "" if the wrapped value is null
  - afterLast
```
@Nonnull
public String afterLast(@Nonnull
                                 String separator)
```
    Returns the substring of the internal value starting right after the last occurrence of the given separator.
    If the separator is not found in the string, or if the internal value is empty, "" is returned.
    An example would be:
```
          Value.of("test.tmp.pdf").afterLast("."); // returns "pdf"
 
```
    Parameters:
    
    separator - the separator string to search for
    
    Returns:
    
    the substring right after the last occurrence of the given separator. This will not include the separator itself.
  - beforeLast
```
@Nonnull
public String beforeLast(@Nonnull
                                  String separator)
```
    Returns the substring of the internal value containing everything up to the last occurrence of the given separator.
    If the separator is not found in the string, or if the internal value is empty, "" is returned.
    An example would be:
```
          Value.of("test.tmp.pdf").beforeLast("."); // returns "test.tmp"
 
```
    Parameters:
    
    separator - the separator string to search for
    
    Returns:
    
    the substring up to the last occurrence of the given separator. This will not include the separator itself.
  - afterFirst
```
@Nonnull
public String afterFirst(@Nonnull
                                  String separator)
```
    Returns the substring of the internal value starting right after the first occurrence of the given separator.
    If the separator is not found in the string, or if the internal value is empty, "" is returned.
    An example would be:
```
          Value.of("test.tmp.pdf").afterFirst("."); // returns "tmp.pdf"
 
```
    Parameters:
    
    separator - the separator string to search for
    
    Returns:
    
    the substring right after the first occurrence of the given separator. This will not include the separator itself.
  - beforeFirst
```
@Nonnull
public String beforeFirst(@Nonnull
                                   String separator)
```
    Returns the substring of the internal value containing everything up to the first occurrence of the given separator.
    If the separator is not found in the string, or if the internal value is empty, "" is returned.
    An example would be:
```
          Value.of("test.tmp.pdf").beforeFirst("."); // returns "test"
 
```
    Parameters:
    
    separator - the separator string to search for
    
    Returns:
    
    the substring up to the first occurrence of the given separator. This will not include the separator itself.
  - substring
```
@Nonnull
public String substring(int startIndex,
                                 int endIndex)
```
    Returns a substring of the string representation of the wrapped value.
    Returns the substring starting at startIndex and ending at endIndex. If the given end index is greater than the string length, the complete substring from startIndex to the end of the string is returned. If the startIndex is greater than the string length, "" is returned.
    
    Parameters:
    
    startIndex - the index of the first character to be included in the sub string
    
    endIndex - the index of the last character to be included in the sub string
    
    Returns:
    
    a substring like String.substring(int, int) or "" if the wrapped value
  - length
```
public int length()
```
    Returns the length of the string representation of the wrapped value.
    
    Returns:
    
    the length of the string representation of the wrapped value or 0, if the wrapped value is null
  - toUpperCase
```
@Nonnull
public String toUpperCase()
```
    Returns an uppercase version of the string representation of the wrapped value.
    
    Returns:
    
    an uppercase version of the string representation of the wrapped value or "" if the wrapped value is null
  - toLowerCase
```
@Nonnull
public String toLowerCase()
```
    Returns an lowercase version of the string representation of the wrapped value.
    
    Returns:
    
    an lowercase version of the string representation of the wrapped value or "" if the wrapped value is null
  - is
```
public boolean is(Class<?>... classes)
```
    Checks if the value implements one of the given classes.
    
    Parameters:
    
    classes - the classes to check against
    
    Returns:
    
    true if the wrapped value is assignable to one of the given classes
  - replace
```
@Nonnull
public Value replace(String pattern,
                              String replacement)
```
    Replaces the given pattern with the given replacement in the string representation of the wrapped object
    
    Parameters:
    
    pattern - the pattern to replace
    
    replacement - the replacement to be used for pattern
    
    Returns:
    
    a Value where all occurrences of pattern in the string representation of the wrapped value are replaced by replacement. If the wrapped value is null, this is returned.
  - regExReplace
```
@Nonnull
public Value regExReplace(String pattern,
                                   String replacement)
```
    Replaces the given regular expression pattern with the given replacement in the string representation of the wrapped object
    
    Parameters:
    
    pattern - the regular expression to replace
    
    replacement - the replacement to be used for pattern
    
    Returns:
    
    a Value where all occurences of pattern in the string representation of the wrapped value are replaced by replacement. If the wrapped value is null, this is returned.
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - in
```
public boolean in(Object... objects)
```
    Determines if the wrapped value is equal to one of the given objects.
    Instead of using if (!value.in(...)) {} consider notIn(Object...).
    
    Parameters:
    
    objects - the set of objects to check against
    
    Returns:
    
    true if the wrapped data is contained in the given objects array, false otherwise
  - notIn
```
public boolean notIn(Object... objects)
```
    Determines if the wrapped value isn't equal to any of the given objects.
    This is the inverse of in(Object...)
    
    Parameters:
    
    objects - the set of objects to check against
    
    Returns:
    
    true if the wrapped data isn't contained in the given objects array, false otherwise
  - equalsIgnoreCase
```
public boolean equalsIgnoreCase(Object otherString)
```
    Determines if the string representation of the wrapped value is equal to the string representation of the given object.
    In this case equality does not take differences of upper and lower case characters into account. Therefore this is boilerplate for asString().equalsIgnoreCase(otherString.toString()) (With proper null checks.)
    
    Parameters:
    
    otherString - the input to compare against
    
    Returns:
    
    true if the string representation of the wrapped object is equal to the string representation of the given parameter, where differences of lower- and uppercase are not taken into account.
    
    See Also:
    
    String.equalsIgnoreCase(String)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - translate
```
@Nonnull
 @CheckReturnValue
public Value translate()
```
    Returns a Value containing a translated value using the string representation of the wrapped value as key.
    
    Returns:
    
    a Value containing a translated value by calling NLS.get(String) if the string representation of the wrapped value starts with $. The dollar sign is skipped when passing the key to NLS. Otherwise this is returned.
    
    See Also:
    
    NLS.get(String)
  - translate
```
@Nonnull
 @CheckReturnValue
public Value translate(String lang)
```
    Returns a Value containing a translated value using the string representation of the wrapped value as key.
    
    Parameters:
    
    lang - a two-letter language code for which the translation is requested
    
    Returns:
    
    a Value containing a translated value by calling NLS.get(String, String) if the string representation of the wrapped value starts with $. The dollar sign is skipped when passing the key to NLS. Otherwise this is returned.
    
    See Also:
    
    NLS.get(String, String)

Class Value

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

Method Detail

of

indexOf

indexOf

isNull

isEmptyString

contains

isFilled

ifFilled

ignore

replaceEmptyWith

replaceIfEmpty

map

asOptional

asOptionalInt

asOptionalString

append

prepend

eat

isNumeric

get

get

first

coerce

get

getString

asString

asString

toString

asSmartRoundedString

asBoolean

asBoolean

asInt

asRomanNumeral

getInteger

asLong

getLong

asDouble

asLocalDate

asLocalDateTime

asLocalTime

asZonedDateTime

asInstant

asInstantOfEpochSeconds

asInstantOfEpochMillis

asLocalDateTimeOfEpochMillis

asLocalDateTimeOfEpochSeconds

getBigDecimal

getBigDecimal

getAmount

asEnum

getEnum

startsWith

endsWith

trim

left

right

afterLast

beforeLast

afterFirst

beforeFirst

substring

length

toUpperCase

toLowerCase

is

replace

regExReplace

equals

in

notIn

equalsIgnoreCase

hashCode

translate