com.helger.commons.traits.IGetterByKeyTrait 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.8+ Library with tons of utility classes required in all projects
/*
* Copyright (C) 2014-2022 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 java.util.Locale;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.helger.commons.collection.impl.CommonsArrayList;
import com.helger.commons.collection.impl.CommonsLinkedHashSet;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.commons.collection.impl.ICommonsOrderedSet;
import com.helger.commons.datetime.PDTFromString;
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 IGetterByKeyTrait
{
/**
* Get the value matching the provided key.
*
* @param aKey
* The key to query. May be null.
* @return The value matching the key. No null constraints
* applicable.
*/
@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 containsNonNullValue (@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 containsNullValue (@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)
{
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)
{
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)
{
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)
{
final Object aValue = getValue (aKey);
return aValue == null ? aDefault : aClass.cast (aValue);
}
/**
* Get the contained value casted to the specified class, but only if the cast
* is possible.
*
* @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
* @see #getSafeCastedValue(Object, Object, Class)
*/
@Nullable
default T getSafeCastedValue (@Nullable final KEYTYPE aKey, @Nonnull final Class aClass)
{
return getSafeCastedValue (aKey, null, aClass);
}
/**
* Implement this method to handle cases of
* {@link #getSafeCastedValue(Object, Object, Class)} that failed because
* invalid provided class.
*
*
* "Key '" + aKey + "' is present, but not as a " + aClass + " but as a " + aValue.getClass ()
*
*
* @param aKey
* Key that was searched
* @param aClass
* The class that was desired
* @param aValue
* The value that was retrieved and cannot be casted to the class
* @since 9.0.1
*/
default void onSafeCastError (@Nullable final KEYTYPE aKey, @Nonnull final Class aClass, @Nonnull final Object aValue)
{
// empty
}
/**
* Get the contained value casted to the specified class, but only if the cast
* is possible.
*
* @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
* @see #getSafeCastedValue(Object, Class)
*/
@Nullable
default T getSafeCastedValue (@Nullable final KEYTYPE aKey, @Nullable final T aDefault, @Nonnull final Class aClass)
{
final Object aValue = getValue (aKey);
final T ret = aValue != null && aClass.isAssignableFrom (aValue.getClass ()) ? aClass.cast (aValue) : aDefault;
if (ret == null && aValue != null)
onSafeCastError (aKey, aClass, aValue);
return ret;
}
/**
* 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.convert (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
* or if type conversion fails.
* @param aClass
* The class to convert to. May not be null.
* @return The object value casted to the passed class. May be
* null if the contained value is null.
* @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.convert (aValue, aClass, aDefault);
}
default boolean getAsBoolean (@Nullable final KEYTYPE aKey)
{
// throws TypeConverterException if value is null
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 if value is null
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 if value is null
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 if value is null
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 if value is null
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 if value is null
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 if value is null
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 if value is null
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,null,String.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default String getAsString (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, 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)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default String getAsString (@Nullable final KEYTYPE aKey, @Nullable final String sDefault)
{
return getConvertedValue (aKey, sDefault, String.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,char [].class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default char [] getAsCharArray (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, 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)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default char [] getAsCharArray (@Nullable final KEYTYPE aKey, @Nullable final char [] aDefault)
{
return getConvertedValue (aKey, aDefault, char [].class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,BigDecimal.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default BigDecimal getAsBigDecimal (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, 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)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default BigDecimal getAsBigDecimal (@Nullable final KEYTYPE aKey, @Nullable final BigDecimal aDefault)
{
return getConvertedValue (aKey, aDefault, BigDecimal.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,BigInteger.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default BigInteger getAsBigInteger (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, 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)
* @see #getConvertedValue(Object,Object, Class)
*/
@Nullable
default BigInteger getAsBigInteger (@Nullable final KEYTYPE aKey, @Nullable final BigInteger aDefault)
{
return getConvertedValue (aKey, aDefault, BigInteger.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,LocalDate.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default LocalDate getAsLocalDate (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, 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)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default LocalDate getAsLocalDate (@Nullable final KEYTYPE aKey, @Nullable final LocalDate aDefault)
{
return getConvertedValue (aKey, aDefault, LocalDate.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,LocalTime.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default LocalTime getAsLocalTime (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, 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)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default LocalTime getAsLocalTime (@Nullable final KEYTYPE aKey, @Nullable final LocalTime aDefault)
{
return getConvertedValue (aKey, aDefault, LocalTime.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,LocalDateTime.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default LocalDateTime getAsLocalDateTime (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, 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)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default LocalDateTime getAsLocalDateTime (@Nullable final KEYTYPE aKey, @Nullable final LocalDateTime aDefault)
{
return getConvertedValue (aKey, aDefault, LocalDateTime.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,byte[].class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default byte [] getAsByteArray (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, byte [].class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,Boolean.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default Boolean getAsBooleanObj (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, Boolean.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,Byte.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default Byte getAsByteObj (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, Byte.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,Character.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default Character getAsCharObj (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, Character.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,Double.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default Double getAsDoubleObj (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, Double.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,Float.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default Float getAsFloatObj (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, Float.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,Integer.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default Integer getAsIntObj (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, Integer.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,Long.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default Long getAsLongObj (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, Long.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,Short.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default Short getAsShortObj (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, Short.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,Blob.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default java.sql.Blob getAsSqlBlob (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, java.sql.Blob.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,Clob.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default java.sql.Clob getAsSqlClob (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, java.sql.Clob.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,Date.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default java.sql.Date getAsSqlDate (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, java.sql.Date.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,NClob.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default java.sql.NClob getAsSqlNClob (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, java.sql.NClob.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,RowId.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default java.sql.RowId getAsSqlRowId (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, java.sql.RowId.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,Time.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default java.sql.Time getAsSqlTime (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, java.sql.Time.class);
}
/**
* @param aKey
* The key to be accessed. May be null.
* @return getConvertedValue (aKey,null,Timestamp.class)
* @see #getConvertedValue(Object,Object,Class)
*/
@Nullable
default java.sql.Timestamp getAsSqlTimestamp (@Nullable final KEYTYPE aKey)
{
return getConvertedValue (aKey, null, java.sql.Timestamp.class);
}
/**
* Get the value as a String, interpreted as a {@link LocalDate}.
*
* @param aKey
* The key to check. May be null.
* @param aContentLocale
* Locale to use for conversion.
* @return null if either the conversion to String or the parsing
* of the String failed.
*/
@Nullable
default LocalDate getAsLocalDate (@Nullable final KEYTYPE aKey, @Nonnull final Locale aContentLocale)
{
final String sStartDate = getAsString (aKey);
return PDTFromString.getLocalDateFromString (sStartDate, aContentLocale);
}
/**
* Get the value as a String, interpreted as a {@link LocalTime}.
*
* @param aKey
* The key to check. May be null.
* @param aContentLocale
* Locale to use for conversion.
* @return null if either the conversion to String or the parsing
* of the String failed.
*/
@Nullable
default LocalTime getAsLocalTime (@Nullable final KEYTYPE aKey, @Nonnull final Locale aContentLocale)
{
final String sStartDate = getAsString (aKey);
return PDTFromString.getLocalTimeFromString (sStartDate, aContentLocale);
}
/**
* Get the value as a String, interpreted as a {@link LocalDateTime}.
*
* @param aKey
* The key to check. May be null.
* @param aContentLocale
* Locale to use for conversion.
* @return null if either the conversion to String or the parsing
* of the String failed.
*/
@Nullable
default LocalDateTime getAsLocalDateTime (@Nullable final KEYTYPE aKey, @Nonnull final Locale aContentLocale)
{
final String sStartDate = getAsString (aKey);
return PDTFromString.getLocalDateTimeFromString (sStartDate, aContentLocale);
}
/**
* Get a list of all attribute values with the same name.
*
* @param aKey
* The key to check. May be null.
* @return null if no such attribute value exists
*/
@Nullable
default ICommonsList getAsStringList (@Nullable final KEYTYPE aKey)
{
return getAsStringList (aKey, null);
}
/**
* Get a list of all attribute values with the same name.
*
* @param aKey
* The key to check. May be null.
* @param aDefault
* The default value to be returned, if no such attribute is present.
* @return aDefault if no such attribute value exists
*/
@Nullable
default ICommonsList getAsStringList (@Nullable final KEYTYPE aKey, @Nullable final ICommonsList aDefault)
{
final Object aValue = getValue (aKey);
if (aValue != null)
{
if (aValue instanceof String [])
{
// multiple values passed in the request
return new CommonsArrayList <> ((String []) aValue);
}
if (aValue instanceof String)
{
// single value passed in the request
return new CommonsArrayList <> ((String) aValue);
}
}
return aDefault;
}
/**
* Get a set of all attribute values with the same name.
*
* @param aKey
* The key to check. May be null.
* @return null if no such attribute value exists
*/
@Nullable
default ICommonsOrderedSet getAsStringSet (@Nullable final KEYTYPE aKey)
{
return getAsStringSet (aKey, null);
}
/**
* Get a set of all attribute values with the same name.
*
* @param aKey
* The key to check. May be null.
* @param aDefault
* The default value to be returned, if no such attribute is present.
* @return aDefault if no such attribute value exists
*/
@Nullable
default ICommonsOrderedSet getAsStringSet (@Nullable final KEYTYPE aKey, @Nullable final ICommonsOrderedSet aDefault)
{
final Object aValue = getValue (aKey);
if (aValue != null)
{
if (aValue instanceof String [])
{
// multiple values passed in the request
return new CommonsLinkedHashSet <> ((String []) aValue);
}
if (aValue instanceof String)
{
// single value passed in the request
return new CommonsLinkedHashSet <> ((String) aValue);
}
}
return aDefault;
}
/**
* Check if a attribute with the given name is present in the request and has
* the specified value.
*
* @param aKey
* The key to check. May be null.
* @param sDesiredValue
* The value to be matched
* @return true if an attribute with the given name is present
* and has the desired value
*/
default boolean hasStringValue (@Nullable final KEYTYPE aKey, @Nullable final String sDesiredValue)
{
return hasStringValue (aKey, sDesiredValue, false);
}
/**
* Check if a attribute with the given name is present in the request and has
* the specified value. If no such attribute is present, the passed default
* value is returned.
*
* @param aKey
* The key to check. May be null.
* @param sDesiredValue
* The value to be matched
* @param bDefault
* the default value to be returned, if the specified attribute is not
* present
* @return true if an attribute with the given name is present
* and has the desired value, false if the attribute is
* present but has a different value. If the attribute is not present,
* the default value is returned.
*/
default boolean hasStringValue (@Nullable final KEYTYPE aKey, @Nullable final String sDesiredValue, final boolean bDefault)
{
final String sValue = getAsString (aKey);
return sValue == null ? bDefault : sValue.equals (sDesiredValue);
}
}