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()
                                 throws ClassCastException

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)
                                 throws ClassCastException

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)
                                 throws ClassCastException

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)
                                 throws ClassCastException

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 .

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

getAsBoolean

default boolean getAsBoolean()
                      throws TypeConverterException

Throws:

TypeConverterException

getAsBoolean

default boolean getAsBoolean(boolean bDefault)

getAsByte

default byte getAsByte()
                throws TypeConverterException

Throws:

TypeConverterException

getAsByte

default byte getAsByte(byte nDefault)

getAsChar

default char getAsChar()
                throws TypeConverterException

Throws:

TypeConverterException

getAsChar

default char getAsChar(char cDefault)

getAsDouble

default double getAsDouble()
                    throws TypeConverterException

Throws:

TypeConverterException

getAsDouble

default double getAsDouble(double dDefault)

getAsFloat

default float getAsFloat()
                  throws TypeConverterException

Throws:

TypeConverterException

getAsFloat

default float getAsFloat(float fDefault)

getAsInt

default int getAsInt()
              throws TypeConverterException

Throws:

TypeConverterException

getAsInt

default int getAsInt(int nDefault)

getAsLong

default long getAsLong()
                throws TypeConverterException

Throws:

TypeConverterException

getAsLong

default long getAsLong(long nDefault)

getAsShort

default short getAsShort()
                  throws TypeConverterException

Throws:

TypeConverterException

getAsShort

default short getAsShort(short nDefault)

getAsString

@Nullable
default String getAsString()
                               throws TypeConverterException

Returns:

getConvertedValue (String.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsString

@Nullable
default String getAsString(@Nullable
                                      String sDefault)
                               throws TypeConverterException

Parameters:

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

Returns:

getConvertedValue (sDefault, String.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Object,Class)

getAsCharArray

@Nullable
default char[] getAsCharArray()
                                  throws TypeConverterException

Returns:

getConvertedValue (char[].class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsCharArray

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

Parameters:

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

Returns:

getConvertedValue (aDefault, char[].class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Object,Class)

getAsBigDecimal

@Nullable
default BigDecimal getAsBigDecimal()
                                       throws TypeConverterException

Returns:

getConvertedValue (BigDecimal.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsBigDecimal

@Nullable
default BigDecimal getAsBigDecimal(@Nullable
                                              BigDecimal aDefault)
                                       throws TypeConverterException

Parameters:

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

Returns:

getConvertedValue (sDefault, BigDecimal.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Object,Class)

getAsBigInteger

@Nullable
default BigInteger getAsBigInteger()
                                       throws TypeConverterException

Returns:

getConvertedValue (BigInteger.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsBigInteger

@Nullable
default BigInteger getAsBigInteger(@Nullable
                                              BigInteger aDefault)
                                       throws TypeConverterException

Parameters:

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

Returns:

getConvertedValue (sDefault, BigInteger.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Object,Class)

getAsLocalDate

@Nullable
default LocalDate getAsLocalDate()
                                     throws TypeConverterException

Returns:

getConvertedValue (LocalDate.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsLocalDate

@Nullable
default LocalDate getAsLocalDate(@Nullable
                                            LocalDate aDefault)
                                     throws TypeConverterException

Parameters:

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

Returns:

getConvertedValue (aDefault, LocalDate.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Object,Class)

getAsLocalTime

@Nullable
default LocalTime getAsLocalTime()
                                     throws TypeConverterException

Returns:

getConvertedValue (LocalTime.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsLocalTime

@Nullable
default LocalTime getAsLocalTime(@Nullable
                                            LocalTime aDefault)
                                     throws TypeConverterException

Parameters:

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

Returns:

getConvertedValue (aDefault, LocalTime.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Object,Class)

getAsLocalDateTime

@Nullable
default LocalDateTime getAsLocalDateTime()
                                             throws TypeConverterException

Returns:

getConvertedValue (LocalDateTime.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsLocalDateTime

@Nullable
default LocalDateTime getAsLocalDateTime(@Nullable
                                                    LocalDateTime aDefault)
                                             throws TypeConverterException

Parameters:

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

Returns:

getConvertedValue (aDefault, LocalDateTime.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Object,Class)

getAsByteArray

@Nullable
default byte[] getAsByteArray()
                                  throws TypeConverterException

Returns:

getConvertedValue (byte[].class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsBooleanObj

@Nullable
default Boolean getAsBooleanObj()
                                    throws TypeConverterException

Returns:

getConvertedValue (Boolean.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsByteObj

@Nullable
default Byte getAsByteObj()
                              throws TypeConverterException

Returns:

getConvertedValue (Byte.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsCharObj

@Nullable
default Character getAsCharObj()
                                   throws TypeConverterException

Returns:

getConvertedValue (Character.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsDoubleObj

@Nullable
default Double getAsDoubleObj()

Returns:

getConvertedValue (Double.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsFloatObj

@Nullable
default Float getAsFloatObj()
                                throws TypeConverterException

Returns:

getConvertedValue (Float.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsIntObj

@Nullable
default Integer getAsIntObj()
                                throws TypeConverterException

Returns:

getConvertedValue (Integer.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsLongObj

@Nullable
default Long getAsLongObj()
                              throws TypeConverterException

Returns:

getConvertedValue (Long.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsShortObj

@Nullable
default Short getAsShortObj()
                                throws TypeConverterException

Returns:

getConvertedValue (Short.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsSqlBlob

@Nullable
default Blob getAsSqlBlob()
                              throws TypeConverterException

Returns:

getConvertedValue (Blob.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsSqlClob

@Nullable
default Clob getAsSqlClob()
                              throws TypeConverterException

Returns:

getConvertedValue (Clob.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsSqlDate

@Nullable
default Date getAsSqlDate()
                              throws TypeConverterException

Returns:

getConvertedValue (Date.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsSqlNClob

@Nullable
default NClob getAsSqlNClob()
                                throws TypeConverterException

Returns:

getConvertedValue (NClob.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsSqlRowId

@Nullable
default RowId getAsSqlRowId()
                                throws TypeConverterException

Returns:

getConvertedValue (RowId.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsSqlTime

@Nullable
default Time getAsSqlTime()
                              throws TypeConverterException

Returns:

getConvertedValue (Time.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)

getAsSqlTimestamp

@Nullable
default Timestamp getAsSqlTimestamp()
                                        throws TypeConverterException

Returns:

getConvertedValue (Timestamp.class)

Throws:

TypeConverterException - in case of an error

See Also:

getConvertedValue(Class)