com.helger.commons.collection.impl

Class SingleElementMap<KEYTYPE,VALUETYPE>

java.lang.Object

com.helger.commons.collection.impl.SingleElementMap<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - The key type.

VALUETYPE - The value type.

All Implemented Interfaces:

ICommonsMap<KEYTYPE,VALUETYPE>, ICloneable<ICommonsMap<KEYTYPE,VALUETYPE>>, Serializable, Map<KEYTYPE,VALUETYPE>

@NotThreadSafe
public class SingleElementMap<KEYTYPE,VALUETYPE>
extends Object
implements ICommonsMap<KEYTYPE,VALUETYPE>

ICommonsMap implementation that can only keep 0 or 1 element.

Author:

Philip Helger

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SingleElementMap()
SingleElementMap(KEYTYPE aKey, VALUETYPE aValue)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object aKey)
boolean	containsValue(Object aValue)
ICommonsSet<Map.Entry<KEYTYPE,VALUETYPE>>	entrySet()
boolean	equals(Object o)
VALUETYPE	get(Object aKey)
SingleElementMap<KEYTYPE,VALUETYPE>	getClone()
int	hashCode()
boolean	isEmpty()
ICommonsSet<KEYTYPE>	keySet()
VALUETYPE	put(KEYTYPE aKey, VALUETYPE aElement)
void	putAll(Map<? extends KEYTYPE,? extends VALUETYPE> aMap)
VALUETYPE	remove(Object aKey)
int	size()
String	toString()
ICommonsCollection<VALUETYPE>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.collection.ext.ICommonsMap

addAll, copyOfEntrySet, copyOfKeySet, copyOfValues, copyOfValues, copyOfValuesMapped, copyOfValuesMapped, findFirstEntry, findFirstKey, findFirstValue, getAsUnmodifiable, getFirstEntry, getFirstKey, getFirstValue, getSortedByKey, getSortedByValue, getSwappedKeyValues, isNotEmpty, putIf, putIfNotNull, removeAll, setAll

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SingleElementMap

public SingleElementMap()

SingleElementMap

public SingleElementMap(@Nullable
                        KEYTYPE aKey,
                        @Nullable
                        VALUETYPE aValue)

Method Detail

getClone

@Nonnull
 @ReturnsMutableCopy
public SingleElementMap<KEYTYPE,VALUETYPE> getClone()

Specified by:

getClone in interface ICloneable<ICommonsMap<KEYTYPE,VALUETYPE>>

Returns:

A 100% deep-copy of the implementing class.

clear

public void clear()

Specified by:

clear in interface Map<KEYTYPE,VALUETYPE>

containsKey

public boolean containsKey(@Nullable
                           Object aKey)

Specified by:

containsKey in interface Map<KEYTYPE,VALUETYPE>

containsValue

public boolean containsValue(@Nullable
                             Object aValue)

Specified by:

containsValue in interface Map<KEYTYPE,VALUETYPE>

get

@Nullable
public VALUETYPE get(@Nullable
                                Object aKey)

Specified by:

get in interface Map<KEYTYPE,VALUETYPE>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<KEYTYPE,VALUETYPE>

put

@Nullable
public VALUETYPE put(@Nullable
                                KEYTYPE aKey,
                                @Nullable
                                VALUETYPE aElement)

Specified by:

put in interface Map<KEYTYPE,VALUETYPE>

putAll

public void putAll(@Nullable
                   Map<? extends KEYTYPE,? extends VALUETYPE> aMap)

Specified by:

putAll in interface Map<KEYTYPE,VALUETYPE>

remove

@Nullable
public VALUETYPE remove(@Nullable
                                   Object aKey)

Specified by:

remove in interface Map<KEYTYPE,VALUETYPE>

size

@Nonnegative
public int size()

Specified by:

size in interface Map<KEYTYPE,VALUETYPE>

keySet

@ReturnsImmutableObject
 @Nonnull
public ICommonsSet<KEYTYPE> keySet()

Specified by:

keySet in interface Map<KEYTYPE,VALUETYPE>

values

@ReturnsImmutableObject
 @Nonnull
public ICommonsCollection<VALUETYPE> values()

Specified by:

values in interface Map<KEYTYPE,VALUETYPE>

entrySet

@Nonnull
 @ReturnsMutableCopy
public ICommonsSet<Map.Entry<KEYTYPE,VALUETYPE>> entrySet()

Specified by:

entrySet in interface Map<KEYTYPE,VALUETYPE>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<KEYTYPE,VALUETYPE>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<KEYTYPE,VALUETYPE>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object