it.unimi.dsi.fastutil.bytes
Class Byte2ReferenceMaps.UnmodifiableMap<V>

java.lang.Object
  extended by it.unimi.dsi.fastutil.bytes.AbstractByte2ReferenceFunction<V>
      extended by it.unimi.dsi.fastutil.bytes.Byte2ReferenceFunctions.UnmodifiableFunction<V>
          extended by it.unimi.dsi.fastutil.bytes.Byte2ReferenceMaps.UnmodifiableMap<V>
All Implemented Interfaces:
Byte2ReferenceFunction<V>, Byte2ReferenceMap<V>, Function<Byte,V>, Serializable, Map<Byte,V>
Direct Known Subclasses:
Byte2ReferenceSortedMaps.UnmodifiableSortedMap
Enclosing class:
Byte2ReferenceMaps

public static class Byte2ReferenceMaps.UnmodifiableMap<V>
extends Byte2ReferenceFunctions.UnmodifiableFunction<V>
implements Byte2ReferenceMap<V>, Serializable

An unmodifiable wrapper class for maps.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.bytes.Byte2ReferenceMap
Byte2ReferenceMap.Entry<V>, Byte2ReferenceMap.FastEntrySet<V>
 
Field Summary
protected  ObjectSet<Byte2ReferenceMap.Entry<V>> entries
           
protected  ByteSet keys
           
protected  Byte2ReferenceMap<V> map
           
static long serialVersionUID
           
protected  ReferenceCollection<V> values
           
 
Fields inherited from class it.unimi.dsi.fastutil.bytes.Byte2ReferenceFunctions.UnmodifiableFunction
function
 
Fields inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2ReferenceFunction
defRetValue
 
Constructor Summary
protected Byte2ReferenceMaps.UnmodifiableMap(Byte2ReferenceMap<V> m)
           
 
Method Summary
 ObjectSet<Byte2ReferenceMap.Entry<V>> byte2ReferenceEntrySet()
          Returns a type-specific set view of the mappings contained in this map.
 void clear()
          Removes all associations from this function (optional operation).
 boolean containsKey(byte k)
           
 boolean containsKey(Object ok)
          Returns true if this function contains a mapping for the specified key.
 boolean containsValue(Object v)
           
 V defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(V defRetValue)
          Sets the default return value.
 ObjectSet<Map.Entry<Byte,V>> entrySet()
          Returns a set view of the mappings contained in this map.
 V get(byte k)
          Returns the value to which the given key is mapped.
 V get(Object k)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 boolean isEmpty()
           
 ByteSet keySet()
          Returns a set view of the keys contained in this map.
 V put(byte k, V v)
          Adds a pair to the map.
 void putAll(Map<? extends Byte,? extends V> m)
           
 V remove(byte k)
          Removes the mapping with the given key.
 V remove(Object k)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 int size()
          Returns the intended number of keys in this function, or -1 if no such number exists.
 String toString()
           
 ReferenceCollection<V> values()
          Returns a set view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2ReferenceFunction
put
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.Function
put
 
Methods inherited from interface java.util.Map
equals, hashCode, put
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values

map

protected final Byte2ReferenceMap<V> map

entries

protected transient volatile ObjectSet<Byte2ReferenceMap.Entry<V>> entries

keys

protected transient volatile ByteSet keys

values

protected transient volatile ReferenceCollection<V> values
Constructor Detail

Byte2ReferenceMaps.UnmodifiableMap

protected Byte2ReferenceMaps.UnmodifiableMap(Byte2ReferenceMap<V> m)
Method Detail

size

public int size()
Description copied from interface: Function
Returns the intended number of keys in this function, or -1 if no such number exists.

Most function implementations will have some knowledge of the intended number of keys in their domain. In some cases, however, this might not be possible.

Specified by:
size in interface Function<Byte,V>
Specified by:
size in interface Map<Byte,V>
Overrides:
size in class Byte2ReferenceFunctions.UnmodifiableFunction<V>
Returns:
the intended number of keys in this function, or -1 if that number is not available.

containsKey

public boolean containsKey(byte k)
Specified by:
containsKey in interface Byte2ReferenceFunction<V>
Overrides:
containsKey in class Byte2ReferenceFunctions.UnmodifiableFunction<V>
See Also:
Function.containsKey(Object)

containsValue

public boolean containsValue(Object v)
Specified by:
containsValue in interface Map<Byte,V>

defaultReturnValue

public V defaultReturnValue()
Description copied from interface: Byte2ReferenceFunction
Gets the default return value.

Specified by:
defaultReturnValue in interface Byte2ReferenceFunction<V>
Overrides:
defaultReturnValue in class Byte2ReferenceFunctions.UnmodifiableFunction<V>
Returns:
the current default return value.

defaultReturnValue

public void defaultReturnValue(V defRetValue)
Description copied from interface: Byte2ReferenceFunction
Sets the default return value. This value must be returned by type-specific versions of get(), put() and remove() to denote that the map does not contain the specified key. It must be 0/false/null by default.

Specified by:
defaultReturnValue in interface Byte2ReferenceFunction<V>
Overrides:
defaultReturnValue in class Byte2ReferenceFunctions.UnmodifiableFunction<V>
Parameters:
defRetValue - the new default return value.
See Also:
Byte2ReferenceFunction.defaultReturnValue()

put

public V put(byte k,
             V v)
Description copied from interface: Byte2ReferenceFunction
Adds a pair to the map.

Specified by:
put in interface Byte2ReferenceFunction<V>
Overrides:
put in class Byte2ReferenceFunctions.UnmodifiableFunction<V>
Parameters:
k - the key.
v - the value.
Returns:
the old value, or the default return value if no value was present for the given key.
See Also:
Function.put(Object,Object)

putAll

public void putAll(Map<? extends Byte,? extends V> m)
Specified by:
putAll in interface Map<Byte,V>

byte2ReferenceEntrySet

public ObjectSet<Byte2ReferenceMap.Entry<V>> byte2ReferenceEntrySet()
Description copied from interface: Byte2ReferenceMap
Returns a type-specific set view of the mappings contained in this map.

This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen Byte2ReferenceMap.entrySet() so that it returns an ObjectSet of objects of type Byte2ReferenceMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:
byte2ReferenceEntrySet in interface Byte2ReferenceMap<V>
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Byte2ReferenceMap.entrySet()

keySet

public ByteSet keySet()
Description copied from interface: Byte2ReferenceMap
Returns a set view of the keys contained in this map.

Note that this specification strengthens the one given in Map.keySet().

Specified by:
keySet in interface Byte2ReferenceMap<V>
Specified by:
keySet in interface Map<Byte,V>
Returns:
a set view of the keys contained in this map.
See Also:
Map.keySet()

values

public ReferenceCollection<V> values()
Description copied from interface: Byte2ReferenceMap
Returns a set view of the values contained in this map.

Note that this specification strengthens the one given in Map.values().

Specified by:
values in interface Byte2ReferenceMap<V>
Specified by:
values in interface Map<Byte,V>
Returns:
a set view of the values contained in this map.
See Also:
Map.values()

clear

public void clear()
Description copied from interface: Function
Removes all associations from this function (optional operation).

Specified by:
clear in interface Function<Byte,V>
Specified by:
clear in interface Map<Byte,V>
Overrides:
clear in class Byte2ReferenceFunctions.UnmodifiableFunction<V>
See Also:
Map.clear()

toString

public String toString()
Overrides:
toString in class Byte2ReferenceFunctions.UnmodifiableFunction<V>

remove

public V remove(byte k)
Description copied from interface: Byte2ReferenceFunction
Removes the mapping with the given key.

Specified by:
remove in interface Byte2ReferenceFunction<V>
Overrides:
remove in class Byte2ReferenceFunctions.UnmodifiableFunction<V>
Returns:
the old value, or the default return value if no value was present for the given key.
See Also:
Function.remove(Object)

get

public V get(byte k)
Description copied from interface: Byte2ReferenceFunction
Returns the value to which the given key is mapped.

Specified by:
get in interface Byte2ReferenceFunction<V>
Overrides:
get in class Byte2ReferenceFunctions.UnmodifiableFunction<V>
Parameters:
k - the key.
Returns:
the corresponding value, or the default return value if no value was present for the given key.
See Also:
Function.get(Object)

containsKey

public boolean containsKey(Object ok)
Description copied from interface: Function
Returns true if this function contains a mapping for the specified key.

Note that for some kind of functions (e.g., hashes) this method will always return true.

Specified by:
containsKey in interface Function<Byte,V>
Specified by:
containsKey in interface Map<Byte,V>
Overrides:
containsKey in class Byte2ReferenceFunctions.UnmodifiableFunction<V>
Parameters:
ok - the key.
Returns:
true if this function associates a value to key.
See Also:
Map.containsKey(Object)

remove

public V remove(Object k)
Description copied from class: AbstractByte2ReferenceFunction
Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:
remove in interface Function<Byte,V>
Specified by:
remove in interface Map<Byte,V>
Overrides:
remove in class Byte2ReferenceFunctions.UnmodifiableFunction<V>
Returns:
the old value, or null if no value was present for the given key.
See Also:
Map.remove(Object)

get

public V get(Object k)
Description copied from class: AbstractByte2ReferenceFunction
Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:
get in interface Function<Byte,V>
Specified by:
get in interface Map<Byte,V>
Overrides:
get in class Byte2ReferenceFunctions.UnmodifiableFunction<V>
Parameters:
k - the key.
Returns:
the corresponding value, or null if no value was present for the given key.
See Also:
Map.get(Object)

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Map<Byte,V>

entrySet

public ObjectSet<Map.Entry<Byte,V>> entrySet()
Description copied from interface: Byte2ReferenceMap
Returns a set view of the mappings contained in this map.

Note that this specification strengthens the one given in Map.entrySet().

Specified by:
entrySet in interface Byte2ReferenceMap<V>
Specified by:
entrySet in interface Map<Byte,V>
Returns:
a set view of the mappings contained in this map.
See Also:
Map.entrySet()


Copyright © 2011. All Rights Reserved.