com.helger.commons.url

Class SMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,String>

com.helger.commons.url.SMap

All Implemented Interfaces:

ICloneable<SMap>, Serializable, Cloneable, Map<String,String>

@NotThreadSafe
public class SMap
extends LinkedHashMap<String,String>
implements ICloneable<SMap>

A special URL parameter map that is made for best inline usage. It's simply a Map<String,String> with more nifty API :)
SMap is short for String-Map

Author:

Philip Helger

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
SMap() Create an empty map.
SMap(Map<String,String> rhs) Create a map base on the given map.
SMap(String sName, int nValue)
SMap(String sName, String sValue)

Method Summary

Methods

Modifier and Type	Method and Description
SMap	add(String sName, boolean bValue)
SMap	add(String sName, int nValue)
SMap	add(String sName, long nValue)
SMap	add(String sName, Object aValue)
SMap	add(String sName, String sValue)
SMap	addAll(Map<String,String> aMap)
SMap	addIfNotEmpty(String sName, String sValue)
SMap	addIfNotNull(String sName, Object aValue)
SMap	addIfNotNull(String sName, String sValue)
SMap	addWithoutValue(String sName)
SMap	getClone()
String	put(String sName, String sValue) Deprecated.
void	putAll(Map<? extends String,? extends String> aMap) Deprecated.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, get, removeEldestEntry

Methods inherited from class java.util.HashMap

clone, containsKey, entrySet, isEmpty, keySet, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

containsKey, entrySet, equals, hashCode, isEmpty, keySet, remove, size, values

Constructor Detail

SMap

public SMap()

Create an empty map.

SMap

public SMap(@Nullable
    Map<String,String> rhs)

Create a map base on the given map. Kind of a copy-constructor.

Parameters:

rhs - The map to add. May not be null.

SMap

public SMap(@Nonnull
    String sName,
    @Nonnull
    String sValue)

SMap

public SMap(@Nonnull
    String sName,
    @Nonnull
    int nValue)

Method Detail

put

@Deprecated
@DevelopersNote(value="Use add instead - only for API compliance!")
public String put(@Nonnull
                                        String sName,
                                        @Nonnull
                                        String sValue)

Deprecated.

Important: this method must be present, because the underlying AbstractMap otherwise throws an exception if this method is not overridden!!!

Specified by:

put in interface Map<String,String>

Overrides:

put in class HashMap<String,String>

Parameters:

sName - Key

sValue - Value

Returns:

The previously assigned value for the given key or null if no previously assigned value is present.

putAll

@Deprecated
@DevelopersNote(value="Use add instead - only for API compliance!")
public void putAll(Map<? extends String,? extends String> aMap)

Deprecated.

Specified by:

putAll in interface Map<String,String>

Overrides:

putAll in class HashMap<String,String>

addIfNotNull

@Nonnull
public SMap addIfNotNull(@Nonnull
                        String sName,
                        @Nonnull
                        Object aValue)

addIfNotNull

@Nonnull
public SMap addIfNotNull(@Nonnull
                        String sName,
                        @Nullable
                        String sValue)

addIfNotEmpty

@Nonnull
public SMap addIfNotEmpty(@Nonnull
                         String sName,
                         @Nullable
                         String sValue)

add

@Nonnull
public SMap add(@Nonnull
               String sName,
               @Nonnull
               Object aValue)

add

@Nonnull
public SMap add(@Nonnull
               String sName,
               @Nonnull
               String sValue)

add

@Nonnull
public SMap add(@Nonnull
               String sName,
               boolean bValue)

add

@Nonnull
public SMap add(@Nonnull
               String sName,
               int nValue)

add

@Nonnull
public SMap add(@Nonnull
               String sName,
               long nValue)

addWithoutValue

@Nonnull
public SMap addWithoutValue(@Nonnull
                           String sName)

addAll

@Nonnull
public SMap addAll(@Nullable
                  Map<String,String> aMap)

getClone

@Nonnull
public SMap getClone()

Specified by:

getClone in interface ICloneable<SMap>

Returns:

A 100% deep-copy of the implementing class.