com.helger.commons.traits

Interface IGetterDirectTrait

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface IGetterDirectTrait

A generic convert Object to anything with convenience API.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default BigDecimal	getAsBigDecimal()
default BigDecimal	getAsBigDecimal(BigDecimal aDefault)
default BigInteger	getAsBigInteger()
default BigInteger	getAsBigInteger(BigInteger aDefault)
default boolean	getAsBoolean()
default boolean	getAsBoolean(boolean bDefault)
default Boolean	getAsBooleanObj()
default byte	getAsByte()
default byte	getAsByte(byte nDefault)
default byte[]	getAsByteArray()
default Byte	getAsByteObj()
default char	getAsChar()
default char	getAsChar(char cDefault)
default char[]	getAsCharArray()
default char[]	getAsCharArray(char[] aDefault)
default Character	getAsCharObj()
default double	getAsDouble()
default double	getAsDouble(double dDefault)
default Double	getAsDoubleObj()
default float	getAsFloat()
default float	getAsFloat(float fDefault)
default Float	getAsFloatObj()
default int	getAsInt()
default int	getAsInt(int nDefault)
default Integer	getAsIntObj()
default LocalDate	getAsLocalDate()
default LocalDate	getAsLocalDate(LocalDate aDefault)
default LocalDateTime	getAsLocalDateTime()
default LocalDateTime	getAsLocalDateTime(LocalDateTime aDefault)
default LocalTime	getAsLocalTime()
default LocalTime	getAsLocalTime(LocalTime aDefault)
default long	getAsLong()
default long	getAsLong(long nDefault)
default Long	getAsLongObj()
default short	getAsShort()
default short	getAsShort(short nDefault)
default Short	getAsShortObj()
default Blob	getAsSqlBlob()
default Clob	getAsSqlClob()
default Date	getAsSqlDate()
default NClob	getAsSqlNClob()
default RowId	getAsSqlRowId()
default Time	getAsSqlTime()
default Timestamp	getAsSqlTimestamp()
default String	getAsString()
default String	getAsString(String sDefault)
default <T> T	getCastedValue() Get the contained value casted to the return type.
default <T> T	getCastedValue(Class<T> aClass) Get the contained value casted to the specified class.
default <T> T	getCastedValue(T aDefault) Get the contained value casted to the return type.
default <T> T	getCastedValue(T aDefault, Class<T> aClass) Get the contained value casted to the specified class.
default <T> T	getConvertedValue(Class<T> aClass) Get the contained value converted using TypeConverter to the passed class.
default <T> T	getConvertedValue(T aDefault, Class<T> aClass) Get the contained value converted using TypeConverter to the passed class.
Object	getValue()
default Class<?>	getValueClass()
default boolean	hasNoValue()
default boolean	hasValue()

Method Detail

getValue

@Nullable
Object getValue()

Returns:

The value of interest. No null constraints applicable.

getValueClass

@Nullable
default Class<?> getValueClass()

Returns:

The class of the value or null if no value is contained.

hasValue

default boolean hasValue()

Returns:

true if the value is not null. Same as getValue()!=null.

hasNoValue

default boolean hasNoValue()

Returns:

true if the value is null. Same as getValue()==null.

getCastedValue

@Nullable
default <T> T getCastedValue()

Get the contained value casted to the return type.

Type Parameters:

T - Destination type

Returns:

The object value casted to the passed class. May be null if the contained value is null.

Throws:

ClassCastException - in case the value types are not convertible

getCastedValue

@Nullable
default <T> T getCastedValue(@Nullable
                                        T aDefault)

Get the contained value casted to the return type.

Type Parameters:

T - Destination type

Parameters:

aDefault - The value to be returned if the retrieved value is null .

Returns:

The object value casted to the passed class. May be null if the contained value is null.

Throws:

ClassCastException - in case the value types are not convertible

getCastedValue

@Nullable
default <T> T getCastedValue(@Nonnull
                                        Class<T> aClass)

Get the contained value casted to the specified class.

Type Parameters:

T - Destination type

Parameters:

aClass - The class to cast to.

Returns:

The object value casted to the passed class. May be null if the contained value is null.

Throws:

ClassCastException - in case the value types are not convertible

getCastedValue

@Nullable
default <T> T getCastedValue(@Nullable
                                        T aDefault,
                                        @Nonnull
                                        Class<T> aClass)

Get the contained value casted to the specified class.

Type Parameters:

T - Destination type

Parameters:

aDefault - The value to be returned if the retrieved value is null .

aClass - The class to cast to.

Returns:

The object value casted to the passed class. May be null if the contained value is null.

Throws:

ClassCastException - in case the value types are not convertible

getConvertedValue

@Nullable
default <T> T getConvertedValue(@Nonnull
                                           Class<T> aClass)

Get the contained value converted using TypeConverter to the passed class.

Type Parameters:

T - Destination type

Parameters:

aClass - The class to convert to.

Returns:

The object value casted to the passed class. May be null if the contained value is null.

Throws:

TypeConverterException - in case of an error

getConvertedValue

@Nullable
default <T> T getConvertedValue(@Nullable
                                           T aDefault,
                                           @Nonnull
                                           Class<T> aClass)

Get the contained value converted using TypeConverter to the passed class.

Type Parameters:

T - Destination type

Parameters:

aDefault - The value to be returned if the retrieved value is null or if type conversion fails.

aClass - The class to convert to. May not be null.

Returns:

The object value casted to the passed class. May be null if the contained value is null.

getAsBoolean

default boolean getAsBoolean()

getAsBoolean

default boolean getAsBoolean(boolean bDefault)

getAsByte

default byte getAsByte()

getAsByte

default byte getAsByte(byte nDefault)

getAsChar

default char getAsChar()

getAsChar

default char getAsChar(char cDefault)

getAsDouble

default double getAsDouble()

getAsDouble

default double getAsDouble(double dDefault)

getAsFloat

default float getAsFloat()

getAsFloat

default float getAsFloat(float fDefault)

getAsInt

default int getAsInt()

getAsInt

default int getAsInt(int nDefault)

getAsLong

default long getAsLong()

getAsLong

default long getAsLong(long nDefault)

getAsShort

default short getAsShort()

getAsShort

default short getAsShort(short nDefault)

getAsString

@Nullable
default String getAsString()

Returns:

getConvertedValue (null, String.class)

See Also:

getConvertedValue(Object, Class)

getAsString

@Nullable
default String getAsString(@Nullable
                                      String sDefault)

Parameters:

sDefault - The value to be returned if the retrieved value is null .

Returns:

getConvertedValue (sDefault, String.class)

See Also:

getConvertedValue(Object,Class)

getAsCharArray

@Nullable
default char[] getAsCharArray()

Returns:

getConvertedValue (null, char[].class)

See Also:

getConvertedValue(Object,Class)

getAsCharArray

@Nullable
default char[] getAsCharArray(@Nullable
                                         char[] aDefault)

Parameters:

aDefault - The value to be returned if the retrieved value is null .

Returns:

getConvertedValue (aDefault, char[].class)

See Also:

getConvertedValue(Object,Class)

getAsBigDecimal

@Nullable
default BigDecimal getAsBigDecimal()

Returns:

getConvertedValue (null, BigDecimal.class)

See Also:

getConvertedValue(Object,Class)

getAsBigDecimal

@Nullable
default BigDecimal getAsBigDecimal(@Nullable
                                              BigDecimal aDefault)

Parameters:

aDefault - The value to be returned if the retrieved value is null .

Returns:

getConvertedValue (sDefault, BigDecimal.class)

See Also:

getConvertedValue(Object,Class)

getAsBigInteger

@Nullable
default BigInteger getAsBigInteger()

Returns:

getConvertedValue (null, BigInteger.class)

See Also:

getConvertedValue(Object,Class)

getAsBigInteger

@Nullable
default BigInteger getAsBigInteger(@Nullable
                                              BigInteger aDefault)

Parameters:

aDefault - The value to be returned if the retrieved value is null .

Returns:

getConvertedValue (sDefault, BigInteger.class)

See Also:

getConvertedValue(Object,Class)

getAsLocalDate

@Nullable
default LocalDate getAsLocalDate()

Returns:

getConvertedValue (null, LocalDate.class)

See Also:

getConvertedValue(Object, Class)

getAsLocalDate

@Nullable
default LocalDate getAsLocalDate(@Nullable
                                            LocalDate aDefault)

Parameters:

aDefault - The value to be returned if the retrieved value is null .

Returns:

getConvertedValue (aDefault, LocalDate.class)

See Also:

getConvertedValue(Object,Class)

getAsLocalTime

@Nullable
default LocalTime getAsLocalTime()

Returns:

getConvertedValue (null, LocalTime.class)

See Also:

getConvertedValue(Object,Class)

getAsLocalTime

@Nullable
default LocalTime getAsLocalTime(@Nullable
                                            LocalTime aDefault)

Parameters:

aDefault - The value to be returned if the retrieved value is null .

Returns:

getConvertedValue (aDefault, LocalTime.class)

See Also:

getConvertedValue(Object,Class)

getAsLocalDateTime

@Nullable
default LocalDateTime getAsLocalDateTime()

Returns:

getConvertedValue (null, LocalDateTime.class)

See Also:

getConvertedValue(Object,Class)

getAsLocalDateTime

@Nullable
default LocalDateTime getAsLocalDateTime(@Nullable
                                                    LocalDateTime aDefault)

Parameters:

aDefault - The value to be returned if the retrieved value is null .

Returns:

getConvertedValue (aDefault, LocalDateTime.class)

See Also:

getConvertedValue(Object,Class)

getAsByteArray

@Nullable
default byte[] getAsByteArray()

Returns:

getConvertedValue (null, byte[].class)

See Also:

getConvertedValue(Object,Class)

getAsBooleanObj

@Nullable
default Boolean getAsBooleanObj()

Returns:

getConvertedValue (null, Boolean.class)

See Also:

getConvertedValue(Object,Class)

getAsByteObj

@Nullable
default Byte getAsByteObj()

Returns:

getConvertedValue (null, Byte.class)

See Also:

getConvertedValue(Object, Class)

getAsCharObj

@Nullable
default Character getAsCharObj()

Returns:

getConvertedValue (null, Character.class)

See Also:

getConvertedValue(Object,Class)

getAsDoubleObj

@Nullable
default Double getAsDoubleObj()

Returns:

getConvertedValue (null, Double.class)

See Also:

getConvertedValue(Object,Class)

getAsFloatObj

@Nullable
default Float getAsFloatObj()

Returns:

getConvertedValue (null, Float.class)

See Also:

getConvertedValue(Object,Class)

getAsIntObj

@Nullable
default Integer getAsIntObj()

Returns:

getConvertedValue (null, Integer.class)

See Also:

getConvertedValue(Object,Class)

getAsLongObj

@Nullable
default Long getAsLongObj()

Returns:

getConvertedValue (null, Long.class)

See Also:

getConvertedValue(Object,Class)

getAsShortObj

@Nullable
default Short getAsShortObj()

Returns:

getConvertedValue (null, Short.class)

See Also:

getConvertedValue(Object,Class)

getAsSqlBlob

@Nullable
default Blob getAsSqlBlob()

Returns:

getConvertedValue (null, Blob.class)

See Also:

getConvertedValue(Object,Class)

getAsSqlClob

@Nullable
default Clob getAsSqlClob()

Returns:

getConvertedValue (null, Clob.class)

See Also:

getConvertedValue(Object,Class)

getAsSqlDate

@Nullable
default Date getAsSqlDate()

Returns:

getConvertedValue (null, Date.class)

See Also:

getConvertedValue(Object, Class)

getAsSqlNClob

@Nullable
default NClob getAsSqlNClob()

Returns:

getConvertedValue (null, NClob.class)

See Also:

getConvertedValue(Object, Class)

getAsSqlRowId

@Nullable
default RowId getAsSqlRowId()

Returns:

getConvertedValue (null, RowId.class)

See Also:

getConvertedValue(Object,Class)

getAsSqlTime

@Nullable
default Time getAsSqlTime()

Returns:

getConvertedValue (null, Time.class)

See Also:

getConvertedValue(Object,Class)

getAsSqlTimestamp

@Nullable
default Timestamp getAsSqlTimestamp()

Returns:

getConvertedValue (null, Timestamp.class)

See Also:

getConvertedValue(Object, Class)