com.helger.commons.traits.IConvertibleByKeyTrait 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
* @param
* The key type. E.g. String etc.
*/
@FunctionalInterface
public interface IConvertibleByKeyTrait
{
@Nullable
Object getValue (@Nullable KEYTYPE aKey);
/**
* @param aKey
* The key to be accessed. May be null.
* @return The class of the value or null if no value is
* contained.
*/
@Nullable
default Class getValueClass (@Nullable final KEYTYPE aKey)
{
final Object aValue = getValue (aKey);
return aValue == null ? null : aValue.getClass ();
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return true if the value is not null. Same as
* getValue()!=null.
*/
default boolean hasValue (@Nullable final KEYTYPE aKey)
{
return getValue (aKey) != null;
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return true if the value is null. Same as
* getValue()==null.
*/
default boolean hasNoValue (@Nullable final KEYTYPE aKey)
{
return getValue (aKey) == null;
}
/**
* Get the contained value casted to the return type.
*
* @param aKey
* The key to be accessed. May be 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 KEYTYPE aKey) throws ClassCastException
{
return GenericReflection.uncheckedCast (getValue (aKey));
}
/**
* Get the contained value casted to the return type.
*
* @param aKey
* The key to be accessed. May be null.
* @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 KEYTYPE aKey, @Nullable final T aDefault) throws ClassCastException
{
final Object aValue = getValue (aKey);
return aValue == null ? aDefault : GenericReflection.uncheckedCast (aValue);
}
/**
* Get the contained value casted to the specified class.
*
* @param aKey
* The key to be accessed. May be 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 KEYTYPE aKey, @Nonnull final Class aClass) throws ClassCastException
{
return aClass.cast (getValue (aKey));
}
/**
* Get the contained value casted to the specified class.
*
* @param aKey
* The key to be accessed. May be null.
* @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 KEYTYPE aKey,
@Nullable final T aDefault,
@Nonnull final Class aClass) throws ClassCastException
{
final Object aValue = getValue (aKey);
return aValue == null ? aDefault : aClass.cast (aValue);
}
/**
* Get the contained value converted using TypeConverter to the passed class.
*
* @param aKey
* The key to be accessed. May be 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 KEYTYPE aKey, @Nonnull final Class aClass)
{
return TypeConverter.convertIfNecessary (getValue (aKey), aClass);
}
/**
* Get the contained value converted using TypeConverter to the passed class.
*
* @param aKey
* The key to be accessed. May be null.
* @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 KEYTYPE aKey,
@Nullable final T aDefault,
@Nonnull final Class aClass)
{
final Object aValue = getValue (aKey);
return aValue == null ? aDefault : TypeConverter.convertIfNecessary (aValue, aClass);
}
default boolean getAsBoolean (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return TypeConverter.convertToBoolean (getValue (aKey));
}
default boolean getAsBoolean (@Nullable final KEYTYPE aKey, final boolean bDefault)
{
return TypeConverter.convertToBoolean (getValue (aKey), bDefault);
}
default byte getAsByte (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return TypeConverter.convertToByte (getValue (aKey));
}
default byte getAsByte (@Nullable final KEYTYPE aKey, final byte nDefault)
{
return TypeConverter.convertToByte (getValue (aKey), nDefault);
}
default char getAsChar (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return TypeConverter.convertToChar (getValue (aKey));
}
default char getAsChar (@Nullable final KEYTYPE aKey, final char cDefault)
{
return TypeConverter.convertToChar (getValue (aKey), cDefault);
}
default double getAsDouble (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return TypeConverter.convertToDouble (getValue (aKey));
}
default double getAsDouble (@Nullable final KEYTYPE aKey, final double dDefault)
{
return TypeConverter.convertToDouble (getValue (aKey), dDefault);
}
default float getAsFloat (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return TypeConverter.convertToFloat (getValue (aKey));
}
default float getAsFloat (@Nullable final KEYTYPE aKey, final float fDefault)
{
return TypeConverter.convertToFloat (getValue (aKey), fDefault);
}
default int getAsInt (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return TypeConverter.convertToInt (getValue (aKey));
}
default int getAsInt (@Nullable final KEYTYPE aKey, final int nDefault)
{
return TypeConverter.convertToInt (getValue (aKey), nDefault);
}
default long getAsLong (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return TypeConverter.convertToLong (getValue (aKey));
}
default long getAsLong (@Nullable final KEYTYPE aKey, final long nDefault)
{
return TypeConverter.convertToLong (getValue (aKey), nDefault);
}
default short getAsShort (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return TypeConverter.convertToShort (getValue (aKey));
}
default short getAsShort (@Nullable final KEYTYPE aKey, final short nDefault)
{
return TypeConverter.convertToShort (getValue (aKey), nDefault);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,String.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default String getAsString (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, String.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @param sDefault
* The value to be returned if the retrieved value is null
* .
* @return getConvertedValue (aKey,sDefault, String.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default String getAsString (@Nullable final KEYTYPE aKey,
@Nullable final String sDefault) throws TypeConverterException
{
return getConvertedValue (aKey, sDefault, String.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,char [].class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default char [] getAsCharArray (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, char [].class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @param aDefault
* The value to be returned if the retrieved value is null
* .
* @return getConvertedValue (aKey, aDefault, char[].class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default char [] getAsCharArray (@Nullable final KEYTYPE aKey,
@Nullable final char [] aDefault) throws TypeConverterException
{
return getConvertedValue (aKey, aDefault, char [].class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,BigDecimal.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default BigDecimal getAsBigDecimal (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, BigDecimal.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @param aDefault
* The value to be returned if the retrieved value is null
* .
* @return getConvertedValue (aKey,aDefault,BigDecimal.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default BigDecimal getAsBigDecimal (@Nullable final KEYTYPE aKey,
@Nullable final BigDecimal aDefault) throws TypeConverterException
{
return getConvertedValue (aKey, aDefault, BigDecimal.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,BigInteger.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default BigInteger getAsBigInteger (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, BigInteger.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @param aDefault
* The value to be returned if the retrieved value is null
* .
* @return getConvertedValue (aKey,aDefault,BigInteger.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Object, Class)
*/
@Nullable
default BigInteger getAsBigInteger (@Nullable final KEYTYPE aKey,
@Nullable final BigInteger aDefault) throws TypeConverterException
{
return getConvertedValue (aKey, aDefault, BigInteger.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,LocalDate.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default LocalDate getAsLocalDate (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, LocalDate.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @param aDefault
* The value to be returned if the retrieved value is null
* .
* @return getConvertedValue (aKey,aDefault,LocalDate.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default LocalDate getAsLocalDate (@Nullable final KEYTYPE aKey,
@Nullable final LocalDate aDefault) throws TypeConverterException
{
return getConvertedValue (aKey, aDefault, LocalDate.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,LocalTime.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default LocalTime getAsLocalTime (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, LocalTime.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @param aDefault
* The value to be returned if the retrieved value is null
* .
* @return getConvertedValue (aKey,aDefault,LocalTime.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default LocalTime getAsLocalTime (@Nullable final KEYTYPE aKey,
@Nullable final LocalTime aDefault) throws TypeConverterException
{
return getConvertedValue (aKey, aDefault, LocalTime.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,LocalDateTime.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default LocalDateTime getAsLocalDateTime (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, LocalDateTime.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @param aDefault
* The value to be returned if the retrieved value is null
* .
* @return getConvertedValue (aKey,aDefault,LocalDateTime.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default LocalDateTime getAsLocalDateTime (@Nullable final KEYTYPE aKey,
@Nullable final LocalDateTime aDefault) throws TypeConverterException
{
return getConvertedValue (aKey, aDefault, LocalDateTime.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,byte[].class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default byte [] getAsByteArray (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, byte [].class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,Boolean.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default Boolean getAsBooleanObj (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, Boolean.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,Byte.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default Byte getAsByteObj (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, Byte.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,Character.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default Character getAsCharObj (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, Character.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,Double.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default Double getAsDoubleObj (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, Double.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,Float.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default Float getAsFloatObj (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, Float.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,Integer.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default Integer getAsIntObj (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, Integer.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,Long.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default Long getAsLongObj (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, Long.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,Short.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default Short getAsShortObj (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, Short.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,Blob.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default java.sql.Blob getAsSqlBlob (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, java.sql.Blob.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,Clob.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default java.sql.Clob getAsSqlClob (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, java.sql.Clob.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,Date.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default java.sql.Date getAsSqlDate (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, java.sql.Date.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,NClob.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default java.sql.NClob getAsSqlNClob (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, java.sql.NClob.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,RowId.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default java.sql.RowId getAsSqlRowId (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, java.sql.RowId.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,Time.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default java.sql.Time getAsSqlTime (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, java.sql.Time.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,Timestamp.class)
* @throws TypeConverterException
* in case of an error
* @see #getConvertedValue(Object,Class)
*/
@Nullable
default java.sql.Timestamp getAsSqlTimestamp (@Nullable final KEYTYPE aKey) throws TypeConverterException
{
return getConvertedValue (aKey, java.sql.Timestamp.class);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy