hu.ibello.core

Interface Value

public interface Value

A wrapper class which encapsulates a value. The encapsulated value can be null. The class has different transformer methods, that translate the value into different java types.

Author:

Kornél Simon

Method Summary

Modifier and Type	Method and Description
Boolean	toBoolean() Transforms the encapsulated value into a Boolean.
default boolean	toBoolean(boolean defaultValue) Transforms the encapsulated value into a boolean.
Byte	toByte() Transforms the encapsulated value into a Byte.
default byte	toByte(byte defaultValue) Transforms the encapsulated value into a byte.
Calendar	toCalendar() Transforms the encapsulated value int a Calendar.
default Calendar	toCalendar(Calendar defaultValue) Transforms the encapsulated value int a Calendar.
Class<?>	toClass() Transforms the encapsulated value into a Class.
Class<?>[]	toClassArray() Transforms the encapsulated value into an array of classes.
Date	toDate() Transforms the encapsulated value int a Date.
default Date	toDate(Date defaultValue) Transforms the encapsulated value int a Date.
Double	toDouble() Transforms the encapsulated value into a Double.
default double	toDouble(double defaultValue) Transforms the encapsulated value into a double.
<E extends Enum<?>> E	toEnum(Class<E> type) Transforms the encapsulated value into the given type of enum.
default <E extends Enum<?>> E	toEnum(E defaultValue) Transforms the encapsulated value into an enum.
<E extends Enum<E>> EnumSet<E>	toEnumSet(Class<E> type) Transforms the encapsulated value into an EnumSet of the given enum type.
File	toFile() Transforms the encapsulated value into a File.
Float	toFloat() Transforms the encapsulated value into a Float.
default float	toFloat(float defaultValue) Transforms the encapsulated value into a float.
Integer	toInteger() Transforms the encapsulated value into an Integer.
default int	toInteger(int defaultValue) Transforms the encapsulated value into an int.
Long	toLong() Transforms the encapsulated value into a Long.
default long	toLong(long defaultValue) Transforms the encapsulated value into a long.
Short	toShort() Transforms the encapsulated value into a Short.
default short	toShort(short defaultValue) Transforms the encapsulated value into a short.
default String	toString(String defaultValue) Transforms the encapsulated value into a string.
String[]	toStringArray() Transforms the encapsulated value into a String array.

Method Detail

toStringArray

String[] toStringArray()

Transforms the encapsulated value into a String array.

• If the value is null, result will be null also.
• If the value is an empty string, result will be an empty array.
• If the value is a string containing only whitespaces, result will be an empty array.
• If the value is a string which contains at least one non-whitespace character, then the method will split the value around commas and will return the array of parts. (Leading and trailing spaces are skipped.)
• If the value is an array or a collection, then the result will contains the string representations of the items in the array or collection.

Returns:

the String array or null

toString

default String toString(String defaultValue)

Transforms the encapsulated value into a string. If the value is null, the result will be the given defaultValue. If the value is a String, then will be used. Otherwise, the method returns the String representation of the value.

Parameters:

defaultValue - default value which is used when the encapsulated value is null; cannot be null

Returns:

the value as String

Throws:

NullPointerException - if the given defaultValue is null

toLong

Long toLong()

Transforms the encapsulated value into a Long. If the value is null, the result will be also null. If the value is a Number, then it's long representation will be used. Otherwise, the method tries to parse the String representation of the value as long. If it is not possible, null will be returned.

Returns:

the value as Long, or null

toLong

default long toLong(long defaultValue)

Transforms the encapsulated value into a long. If the value is null, the result will be the given defaultValue. If the value is a Number, then it's long representation will be used. Otherwise, the method tries to parse the String representation of the value as long. If it is not possible, the defaultValue will be returned.

Parameters:

defaultValue - default value which is used when the encapsulated value cannot be transformed to a long

Returns:

the value as long

toInteger

Integer toInteger()

Transforms the encapsulated value into an Integer. If the value is null, the result will be also null. If the value is a Number, then it's integer representation will be used. Otherwise, the method tries to parse the String representation of the value as integer. If it is not possible, null will be returned.

Returns:

the value as Integer, or null

toInteger

default int toInteger(int defaultValue)

Transforms the encapsulated value into an int. If the value is null, the result will be the given defaultValue. If the value is a Number, then it's integer representation will be used. Otherwise, the method tries to parse the String representation of the value as integer. If it is not possible, the defaultValue will be returned.

Parameters:

defaultValue - default value which is used when the encapsulated value cannot be transformed to a int

Returns:

value as int

toShort

Short toShort()

Transforms the encapsulated value into a Short. If the value is null, the result will be also null. If the value is a Number, then it's short representation will be used. Otherwise, the method tries to parse the String representation of the value as short. If it is not possible, null will be returned.

Returns:

the value as Short, or null

toShort

default short toShort(short defaultValue)

Transforms the encapsulated value into a short. If the value is null, the result will be the given defaultValue. If the value is a Number, then it's short representation will be used. Otherwise, the method tries to parse the String representation of the value as short. If it is not possible, the defaultValue will be returned.

Parameters:

defaultValue - default value which is used when the encapsulated value cannot be transformed to a short

Returns:

value as short

toByte

Byte toByte()

Transforms the encapsulated value into a Byte. If the value is null, the result will be also null. If the value is a Number, then it's byte representation will be used. Otherwise, the method tries to parse the String representation of the value as byte. If it is not possible, null will be returned.

Returns:

the value as Byte, or null

toByte

default byte toByte(byte defaultValue)

Transforms the encapsulated value into a byte. If the value is null, the result will be the given defaultValue. If the value is a Number, then it's byte representation will be used. Otherwise, the method tries to parse the String representation of the value as byte. If it is not possible, the defaultValue will be returned.

Parameters:

defaultValue - default value which is used when the encapsulated value cannot be transformed to a byte

Returns:

value as byte

toDouble

Double toDouble()

Transforms the encapsulated value into a Double. If the value is null, the result will be also null. If the value is a Number, then it's double representation will be used. Otherwise, the method tries to parse the String representation of the value as double. If it is not possible, null will be returned.

Returns:

the value as Double, or null

toDouble

default double toDouble(double defaultValue)

Transforms the encapsulated value into a double. If the value is null, the result will be the given defaultValue. If the value is a Number, then it's double representation will be used. Otherwise, the method tries to parse the String representation of the value as double. If it is not possible, the defaultValue will be returned.

Parameters:

defaultValue - default value which is used when the encapsulated value cannot be transformed to a double

Returns:

value as double

toFloat

Float toFloat()

Transforms the encapsulated value into a Float. If the value is null, the result will be also null. If the value is a Number, then it's float representation will be used. Otherwise, the method tries to parse the String representation of the value as float. If it is not possible, null will be returned.

Returns:

the value as Float, or null

toFloat

default float toFloat(float defaultValue)

Transforms the encapsulated value into a float. If the value is null, the result will be the given defaultValue. If the value is a Number, then it's float representation will be used. Otherwise, the method tries to parse the String representation of the value as float. If it is not possible, the defaultValue will be returned.

Parameters:

defaultValue - default value which is used when the encapsulated value cannot be transformed to a float

Returns:

value as float

toBoolean

Boolean toBoolean()

Transforms the encapsulated value into a Boolean. If the value is null, the result will be also null. If the value is a Boolean, then it will be returned. Otherwise, the method parses the String representation of the value as boolean.

Returns:

the value as Boolean, or null

toBoolean

default boolean toBoolean(boolean defaultValue)

Transforms the encapsulated value into a boolean. If the value is null, the result will be the given defaultValue. If the value is a Boolean, then it will be returned. Otherwise, the method parses the String representation of the value as boolean.

Parameters:

defaultValue - default value which is used when the encapsulated value is null

Returns:

value as boolean

toDate

Date toDate()

Transforms the encapsulated value int a Date. If the value is null, the result will be also null. If the value is a Date, then it will be returned. If the value is a date-like object ( Calendar, Instant, XMLGregorianCalendar, OffsetDateTime, ZonedDateTime, LocalDate, LocalDateTime), then it will be transformed into a Date. Otherwise, the method parses the String representation of the value as a Date. In this case relative date is noticed as well. A relative date always begins with a "+" or "-" sign, depending on whether you want a future or past date. This is followed by a combination of numbers and letters. Each number is followed by a letter that gives the unit of measure for the number. This may be:

• "Y": year
• "M": month
• "D": day of month
• "h": hour
• "m": minute
• "s": second

Examples: "-1Y30h", "+1D".

Returns:

value as Date

toDate

default Date toDate(Date defaultValue)

Transforms the encapsulated value int a Date. If the value is null, the result will be the given defaultValue. If the value is a Date, then it will be returned. If the value is a date-like object ( Calendar, Instant, XMLGregorianCalendar, OffsetDateTime, ZonedDateTime, LocalDate, LocalDateTime), then it will be transformed into a Date. Otherwise, the method parses the String representation of the value as a Date. In this case relative date is noticed as well. A relative date always begins with a "+" or "-" sign, depending on whether you want a future or past date. This is followed by a combination of numbers and letters. Each number is followed by a letter that gives the unit of measure for the number. This may be:

• "Y": year
• "M": month
• "D": day of month
• "h": hour
• "m": minute
• "s": second

Examples: "-1Y30h", "+1D".

Parameters:

defaultValue - default value which is used when the encapsulated value is null

Returns:

value as Date

toCalendar

Calendar toCalendar()

Transforms the encapsulated value int a Calendar. If the value is null, the result will be also null. If the value is a Calendar, then it will be returned. If the value is a date-like object ( Date, Instant, XMLGregorianCalendar, OffsetDateTime, ZonedDateTime, LocalDate, LocalDateTime), then it will be transformed into a Calendar. Otherwise, the method parses the String representation of the value as a Calendar. In this case relative date is noticed as well. A relative date always begins with a "+" or "-" sign, depending on whether you want a future or past date. This is followed by a combination of numbers and letters. Each number is followed by a letter that gives the unit of measure for the number. This may be:

• "Y": year
• "M": month
• "D": day of month
• "h": hour
• "m": minute
• "s": second

Examples: "-1Y30h", "+1D".

Returns:

value as Calendar

toCalendar

default Calendar toCalendar(Calendar defaultValue)

Transforms the encapsulated value int a Calendar. If the value is null, the result will be the given defaultValue. If the value is a Calendar, then it will be returned. If the value is a date-like object ( Date, Instant, XMLGregorianCalendar, OffsetDateTime, ZonedDateTime, LocalDate, LocalDateTime), then it will be transformed into a Calendar. Otherwise, the method parses the String representation of the value as a Calendar. In this case relative date is noticed as well. A relative date always begins with a "+" or "-" sign, depending on whether you want a future or past date. This is followed by a combination of numbers and letters. Each number is followed by a letter that gives the unit of measure for the number. This may be:

• "Y": year
• "M": month
• "D": day of month
• "h": hour
• "m": minute
• "s": second

Examples: "-1Y30h", "+1D".

Parameters:

defaultValue - default value which is used when the encapsulated value is null

Returns:

value as Calendar

toEnum

<E extends Enum<?>> E toEnum(Class<E> type)

Transforms the encapsulated value into the given type of enum. If the value is null, the result will be also null. If the value is the right type, then it will be returned. Otherwise, the method tries to parse the result from the String representation of the value. For that, the name of the enum constants will be used (see Enum.name()). The method is able to find the right enum constant case-insensitively. If it is not possible, then the result will be null.

Type Parameters:

E - the type of the result

Parameters:

type - the enum type we want to have as result

Returns:

the value as the given type, or null

toEnum

default <E extends Enum<?>> E toEnum(E defaultValue)

Transforms the encapsulated value into an enum. If the value is null, the result will be the given defaultValue. If the value is the right type, then it will be returned. Otherwise, the method tries to parse the result from the String representation of the value. For that, the name of the enum constants will be used (see Enum.name()). The method is able to find the right enum constant case-insensitively. If it is not possible, then the result will be the defaultValue.

Type Parameters:

E - the type of the result

Parameters:

defaultValue - default value which will be returned if value cannot be parsed to an enum constant; should be non-null

Returns:

the value as enum constant

Throws:

NullPointerException - if the given defaultValue is null

toEnumSet

<E extends Enum<E>> EnumSet<E> toEnumSet(Class<E> type)

Transforms the encapsulated value into an EnumSet of the given enum type.

• If the value is null, result will be null also.
• If the value is an empty string, result will be an empty set.
• If the value is a string containing only whitespaces, result will be an empty set.
• If the value is a string which contains at least one non-whitespace character, then the method will split the value around commas and will try to parse the parts as enum constants.
• If the value is an array or a collection, then the result will try to parse the items in the array or collection as enum constants.

If the method parses a string as enum constant, then it tries to match the string value to the name of the constant. The method is able to find the right enum constants case-insensitively. Invalid names will not result an exception - they just skipped. Therefore it is possible to have an empty set as result.

Type Parameters:

E - the desired enum type

Parameters:

type - the enum type we want to have in the result set

Returns:

value as the given type of enum set, or null

toFile

File toFile()

Transforms the encapsulated value into a File. If the value is null, the result will be also null. If the value is a File instance, then it will be returned. Otherwise, a new File instance will be constructed from the string representation of the value.

Returns:

the value as File, or null

toClass

Class<?> toClass()

Transforms the encapsulated value into a Class. If the value is null, the result will be also null. If the value is a Class instance, then it will be returned. Otherwise, a new Class instance will be constructed from the string representation of the value.

Returns:

the value as Class, or null

toClassArray

Class<?>[] toClassArray()

Transforms the encapsulated value into an array of classes.

• If the value is null, result will be null also.
• If the value is an empty string, result will be an empty array.
• If the value is a string containing only whitespaces, result will be an empty array.
• If the value is a string which contains at least one non-whitespace character, then the method will split the value around commas and will try to parse the parts as classes.
• If the value is an array or a collection, then the result will try to parse the items in the array or collection as classes.

To parse a string into a class, the full class name is used.

Returns:

the value as array of classes, or null