com.helger.commons.traits.IConvertibleDirectTrait Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation
Show all versions of ph-commons Show documentation
Java 1.6+ Library with tons of utility classes required in all projects
/**
* Copyright (C) 2014-2016 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.helger.commons.traits;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.helger.commons.lang.GenericReflection;
import com.helger.commons.typeconvert.TypeConverter;
import com.helger.commons.typeconvert.TypeConverterException;
/**
* A generic convert Object to anything with convenience API.
*
* @author Philip Helger
*/
@FunctionalInterface
public interface IConvertibleDirectTrait
{
@Nullable
Object getValue ();
/**
* @return The class of the value or null if no value is
* contained.
*/
@Nullable
default Class getValueClass ()
{
final Object aValue = getValue ();
return aValue == null ? null : aValue.getClass ();
}
/**
* @return true if the value is not null. Same as
* getValue()!=null.
*/
default boolean hasValue ()
{
return getValue () != null;
}
/**
* @return true if the value is null. Same as
* getValue()==null.
*/
default boolean hasNoValue ()
{
return getValue () == null;
}
/**
* Get the contained value casted to the return type.
*
* @return 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
* @param
* Destination type
*/
@Nullable
default T getCastedValue () throws ClassCastException
{
return GenericReflection.uncheckedCast (getValue ());
}
/**
* Get the contained value casted to the return type.
*
* @param aDefault
* The value to be returned if the retrieved value is null
* .
* @return 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
* @param
* Destination type
*/
@Nullable
default T getCastedValue (@Nullable final T aDefault) throws ClassCastException
{
final Object aValue = getValue ();
return aValue == null ? aDefault : GenericReflection.uncheckedCast (aValue);
}
/**
* Get the contained value casted to the specified class.
*
* @param aClass
* The class to cast to.
* @return 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
* @param
* Destination type
*/
@Nullable
default T getCastedValue (@Nonnull final Class aClass) throws ClassCastException
{
return aClass.cast (getValue ());
}
/**
* Get the contained value casted to the specified class.
*
* @param aDefault
* The value to be returned if the retrieved value is null
* .
* @param aClass
* The class to cast to.
* @return 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
* @param
* Destination type
*/
@Nullable
default T getCastedValue (@Nullable final T aDefault, @Nonnull final Class aClass) throws ClassCastException
{
final Object aValue = getValue ();
return aValue == null ? aDefault : aClass.cast (aValue);
}
/**
* Get the contained value converted using TypeConverter to the passed class.
*
* @param aClass
* The class to convert to.
* @return The object value casted to the passed class. May be
* null if the contained value is null.
* @throws TypeConverterException
* in case of an error
* @param
* Destination type
*/
@Nullable
default T getConvertedValue (@Nonnull final Class aClass)
{
return TypeConverter.convertIfNecessary (getValue (), aClass);
}
/**
* Get the contained value converted using TypeConverter to the passed class.
*
* @param aDefault
* The value to be returned if the retrieved value is null
* .
* @param aClass
* The class to convert to.
* @return The object value casted to the passed class. May be
* null if the contained value is null.
* @throws TypeConverterException
* in case of an error
* @param
* Destination type
*/
@Nullable
default T getConvertedValue (@Nullable final T aDefault, @Nonnull final Class aClass)
{
final Object aValue = getValue ();
return aValue == null ? aDefault : TypeConverter.convertIfNecessary (aValue, aClass);
}
default boolean getAsBoolean () throws TypeConverterException
{
return TypeConverter.convertToBoolean (getValue ());
}
default boolean getAsBoolean (final boolean bDefault)
{
return TypeConverter.convertToBoolean (getValue (), bDefault);
}
default byte getAsByte () throws TypeConverterException
{
return TypeConverter.convertToByte (getValue ());
}
default byte getAsByte (final byte nDefault)
{
return TypeConverter.convertToByte (getValue (), nDefault);
}
default char getAsChar () throws TypeConverterException
{
return TypeConverter.convertToChar (getValue ());
}
default char getAsChar (final char cDefault)
{
return TypeConverter.convertToChar (getValue (), cDefault);
}
default double getAsDouble () throws TypeConverterException
{
return TypeConverter.convertToDouble (getValue ());
}
default double getAsDouble (final double dDefault)
{
return TypeConverter.convertToDouble (getValue (), dDefault);
}
default float getAsFloat () throws TypeConverterException
{
return TypeConverter.convertToFloat (getValue ());
}
default float getAsFloat (final float fDefault)
{
return TypeConverter.convertToFloat (getValue (), fDefault);
}
default int getAsInt () throws TypeConverterException
{
return TypeConverter.convertToInt (getValue ());
}
default int getAsInt (final int nDefault)
{
return TypeConverter.convertToInt (getValue (), nDefault);
}
default long getAsLong () throws TypeConverterException
{
return TypeConverter.convertToLong (getValue ());
}
default long getAsLong (final long nDefault)
{
return TypeConverter.convertToLong (getValue (), nDefault);
}
default short getAsShort () throws TypeConverterException
{
return TypeConverter.convertToShort (getValue ());
}
default short getAsShort (final short nDefault)
{
return TypeConverter.convertToShort (getValue (), nDefault);
}
/**
* @return getConvertedValue (String.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default String getAsString () throws TypeConverterException
{
return getConvertedValue (String.class);
}
/**
* @param sDefault
* The value to be returned if the retrieved value is null
* .
* @return getConvertedValue (sDefault, String.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default String getAsString (@Nullable final String sDefault) throws TypeConverterException
{
return getConvertedValue (sDefault, String.class);
}
/**
* @return getConvertedValue (char[].class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default char [] getAsCharArray () throws TypeConverterException
{
return getConvertedValue (char [].class);
}
/**
* @param aDefault
* The value to be returned if the retrieved value is null
* .
* @return getConvertedValue (aDefault, char[].class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default char [] getAsCharArray (@Nullable final char [] aDefault) throws TypeConverterException
{
return getConvertedValue (aDefault, char [].class);
}
/**
* @return getConvertedValue (BigDecimal.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default BigDecimal getAsBigDecimal () throws TypeConverterException
{
return getConvertedValue (BigDecimal.class);
}
/**
* @param aDefault
* The value to be returned if the retrieved value is null
* .
* @return getConvertedValue (sDefault, BigDecimal.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default BigDecimal getAsBigDecimal (@Nullable final BigDecimal aDefault) throws TypeConverterException
{
return getConvertedValue (aDefault, BigDecimal.class);
}
/**
* @return getConvertedValue (BigInteger.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default BigInteger getAsBigInteger () throws TypeConverterException
{
return getConvertedValue (BigInteger.class);
}
/**
* @param aDefault
* The value to be returned if the retrieved value is null
* .
* @return getConvertedValue (sDefault, BigInteger.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default BigInteger getAsBigInteger (@Nullable final BigInteger aDefault) throws TypeConverterException
{
return getConvertedValue (aDefault, BigInteger.class);
}
/**
* @return getConvertedValue (LocalDate.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default LocalDate getAsLocalDate () throws TypeConverterException
{
return getConvertedValue (LocalDate.class);
}
/**
* @param aDefault
* The value to be returned if the retrieved value is null
* .
* @return getConvertedValue (aDefault, LocalDate.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default LocalDate getAsLocalDate (@Nullable final LocalDate aDefault) throws TypeConverterException
{
return getConvertedValue (aDefault, LocalDate.class);
}
/**
* @return getConvertedValue (LocalTime.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default LocalTime getAsLocalTime () throws TypeConverterException
{
return getConvertedValue (LocalTime.class);
}
/**
* @param aDefault
* The value to be returned if the retrieved value is null
* .
* @return getConvertedValue (aDefault, LocalTime.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default LocalTime getAsLocalTime (@Nullable final LocalTime aDefault) throws TypeConverterException
{
return getConvertedValue (aDefault, LocalTime.class);
}
/**
* @return getConvertedValue (LocalDateTime.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default LocalDateTime getAsLocalDateTime () throws TypeConverterException
{
return getConvertedValue (LocalDateTime.class);
}
/**
* @param aDefault
* The value to be returned if the retrieved value is null
* .
* @return getConvertedValue (aDefault, LocalDateTime.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default LocalDateTime getAsLocalDateTime (@Nullable final LocalDateTime aDefault) throws TypeConverterException
{
return getConvertedValue (LocalDateTime.class);
}
/**
* @return getConvertedValue (byte[].class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default byte [] getAsByteArray () throws TypeConverterException
{
return getConvertedValue (byte [].class);
}
/**
* @return getConvertedValue (Boolean.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default Boolean getAsBooleanObj () throws TypeConverterException
{
return getConvertedValue (Boolean.class);
}
/**
* @return getConvertedValue (Byte.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default Byte getAsByteObj () throws TypeConverterException
{
return getConvertedValue (Byte.class);
}
/**
* @return getConvertedValue (Character.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default Character getAsCharObj () throws TypeConverterException
{
return getConvertedValue (Character.class);
}
/**
* @return getConvertedValue (Double.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default Double getAsDoubleObj ()
{
return getConvertedValue (Double.class);
}
/**
* @return getConvertedValue (Float.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default Float getAsFloatObj () throws TypeConverterException
{
return getConvertedValue (Float.class);
}
/**
* @return getConvertedValue (Integer.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default Integer getAsIntObj () throws TypeConverterException
{
return getConvertedValue (Integer.class);
}
/**
* @return getConvertedValue (Long.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default Long getAsLongObj () throws TypeConverterException
{
return getConvertedValue (Long.class);
}
/**
* @return getConvertedValue (Short.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default Short getAsShortObj () throws TypeConverterException
{
return getConvertedValue (Short.class);
}
/**
* @return getConvertedValue (Blob.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default java.sql.Blob getAsSqlBlob () throws TypeConverterException
{
return getConvertedValue (java.sql.Blob.class);
}
/**
* @return getConvertedValue (Clob.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default java.sql.Clob getAsSqlClob () throws TypeConverterException
{
return getConvertedValue (java.sql.Clob.class);
}
/**
* @return getConvertedValue (Date.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default java.sql.Date getAsSqlDate () throws TypeConverterException
{
return getConvertedValue (java.sql.Date.class);
}
/**
* @return getConvertedValue (NClob.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default java.sql.NClob getAsSqlNClob () throws TypeConverterException
{
return getConvertedValue (java.sql.NClob.class);
}
/**
* @return getConvertedValue (RowId.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default java.sql.RowId getAsSqlRowId () throws TypeConverterException
{
return getConvertedValue (java.sql.RowId.class);
}
/**
* @return getConvertedValue (Time.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default java.sql.Time getAsSqlTime () throws TypeConverterException
{
return getConvertedValue (java.sql.Time.class);
}
/**
* @return getConvertedValue (Timestamp.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Class)
*/
@Nullable
default java.sql.Timestamp getAsSqlTimestamp () throws TypeConverterException
{
return getConvertedValue (java.sql.Timestamp.class);
}
/**
* Convert the passed object to a convertible object :)
*
* @param o
* Source object. May be null.
* @return The convertible object
*/
@Nonnull
static IConvertibleDirectTrait wrap (@Nullable final Object o)
{
return () -> o;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy