uk.org.retep.util.collections.map.VariableMap Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 1998-2010, Peter T Mount
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of the retep.org.uk nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
*
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package uk.org.retep.util.collections.map;
import java.util.Map;
import uk.org.retep.util.math.MathUtils;
import uk.org.retep.util.string.StringUtils;
/**
* A VariableMap is an implementation of a map that will attempt to convert
* the values into common objects, specifically String, Number (int, long etc)
*
* @param Class representing the Keys
* @author peter
* @since 8.12.12
*/
public class VariableMap
extends DefaultMap
{
private static final long serialVersionUID = -4468280896324809819L;
/**
* Constructor utilising a standard HashMap.
*/
public VariableMap()
{
super();
}
/**
* Constructor utilising a standard HashMap.
* @param i
*/
public VariableMap( final int i )
{
super( i );
}
/**
* Constructor utilising a standard HashMap.
* @param i
* @param f
*/
public VariableMap( final int i, final float f )
{
super( i, f );
}
public VariableMap( final Map map )
{
super( map );
}
/**
* Return the value as a String
* @param key Key within the map
* @return String or null if not present
*/
public final String getString( final K key )
{
return StringUtils.valueOf( get( key ) );
}
/**
* Return the value as a String
* @param key Key within the map
* @param defaultValue Default value if the key is not present
* @return String or defaultValue if not present
*/
public final String getString( final K key, final String defaultValue )
{
return StringUtils.valueOf( get( key ), defaultValue );
}
/**
* Return the value as a Long
* @param key Key within the map
* @return Long or null if not present
*/
public final Long getLong( final K key )
{
return MathUtils.toLong( get( key ) );
}
/**
* Return the value as a Long
* @param key Key within the map
* @param defaultValue Default value if the key is not present
* @return Long or defaultValue if not present
*/
public final Long getLong( final K key, final Long defaultValue )
{
return MathUtils.toLong( get( key ), defaultValue );
}
/**
* Return the value as a Short
* @param key Key within the map
* @return Short or null if not present
*/
public final Short getShort( final K key )
{
return MathUtils.toShort( get( key ) );
}
/**
* Return the value as a Short
* @param key Key within the map
* @param defaultValue Default value if the key is not present
* @return Short or defaultValue if not present
*/
public final Short getShort( final K key, final Short defaultValue )
{
return MathUtils.toShort( get( key ), defaultValue );
}
/**
* Return the value as a Integer
* @param key Key within the map
* @return Integer or null if not present
*/
public final Integer getInteger( final K key )
{
return MathUtils.toInteger( get( key ) );
}
/**
* Return the value as a Integer
* @param key Key within the map
* @param defaultValue Default value if the key is not present
* @return Integer or defaultValue if not present
*/
public final Integer getInteger( final K key, final Integer defaultValue )
{
return MathUtils.toInteger( get( key ), defaultValue );
}
/**
* Return the value as a Float
* @param key Key within the map
* @return Float or null if not present
*/
public final Float getFloat( final K key )
{
return MathUtils.toFloat( get( key ) );
}
/**
* Return the value as a Float
* @param key Key within the map
* @param defaultValue Default value if the key is not present
* @return Float or defaultValue if not present
*/
public final Float getFloat( final K key, final Float defaultValue )
{
return MathUtils.toFloat( get( key ), defaultValue );
}
/**
* Return the value as a Double
* @param key Key within the map
* @return Double or null if not present
*/
public final Double getDouble( final K key )
{
return MathUtils.toDouble( get( key ) );
}
/**
* Return the value as a Double
* @param key Key within the map
* @param defaultValue Default value if the key is not present
* @return Double or defaultValue if not present
*/
public final Double getDouble( final K key, final Double defaultValue )
{
return MathUtils.toDouble( get( key ), defaultValue );
}
@Override
public String toString()
{
final StringBuilder sb = new StringBuilder();
sb.append( getClass().getName() ).append( "=[" );
if( !isEmpty() )
{
for( Map.Entry e : entrySet() )
{
sb.append( e ).append( ',' );
}
sb.setLength( sb.length() - 1 );
}
return sb.append( ']' ).toString();
}
}