it.unimi.dsi.fastutil.bytes
Class Byte2ByteMaps.UnmodifiableMap

java.lang.Object
  extended by it.unimi.dsi.fastutil.bytes.AbstractByte2ByteFunction
      extended by it.unimi.dsi.fastutil.bytes.Byte2ByteFunctions.UnmodifiableFunction
          extended by it.unimi.dsi.fastutil.bytes.Byte2ByteMaps.UnmodifiableMap
All Implemented Interfaces:
Byte2ByteFunction, Byte2ByteMap, Function<Byte,Byte>, Serializable, Map<Byte,Byte>
Direct Known Subclasses:
Byte2ByteSortedMaps.UnmodifiableSortedMap
Enclosing class:
Byte2ByteMaps

public static class Byte2ByteMaps.UnmodifiableMap
extends Byte2ByteFunctions.UnmodifiableFunction
implements Byte2ByteMap, 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.Byte2ByteMap
Byte2ByteMap.Entry, Byte2ByteMap.FastEntrySet
 
Field Summary
protected  ObjectSet<Byte2ByteMap.Entry> entries
           
protected  ByteSet keys
           
protected  Byte2ByteMap map
           
static long serialVersionUID
           
protected  ByteCollection values
           
 
Fields inherited from class it.unimi.dsi.fastutil.bytes.Byte2ByteFunctions.UnmodifiableFunction
function
 
Fields inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2ByteFunction
defRetValue
 
Constructor Summary
protected Byte2ByteMaps.UnmodifiableMap(Byte2ByteMap m)
           
 
Method Summary
 ObjectSet<Byte2ByteMap.Entry> byte2ByteEntrySet()
          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(byte v)
           
 boolean containsValue(Object ov)
           
 byte defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(byte defRetValue)
          Sets the default return value.
 ObjectSet<Map.Entry<Byte,Byte>> entrySet()
          Returns a set view of the mappings contained in this map.
 byte get(byte k)
          Returns the value to which the given key is mapped.
 boolean isEmpty()
           
 ByteSet keySet()
          Returns a set view of the keys contained in this map.
 byte put(byte k, byte v)
          Adds a pair to the map.
 Byte put(Byte k, Byte v)
          Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
 void putAll(Map<? extends Byte,? extends Byte> m)
           
 byte remove(byte k)
          Removes the mapping with the given key.
 int size()
          Returns the intended number of keys in this function, or -1 if no such number exists.
 String toString()
           
 ByteCollection values()
          Returns a set view of the values contained in this map.
 
Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByte2ByteFunction
get, remove
 
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
get, remove
 
Methods inherited from interface java.util.Map
equals, get, hashCode, remove
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values

map

protected final Byte2ByteMap map

entries

protected transient volatile ObjectSet<Byte2ByteMap.Entry> entries

keys

protected transient volatile ByteSet keys

values

protected transient volatile ByteCollection values
Constructor Detail

Byte2ByteMaps.UnmodifiableMap

protected Byte2ByteMaps.UnmodifiableMap(Byte2ByteMap 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,Byte>
Specified by:
size in interface Map<Byte,Byte>
Overrides:
size in class Byte2ByteFunctions.UnmodifiableFunction
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 Byte2ByteFunction
Overrides:
containsKey in class Byte2ByteFunctions.UnmodifiableFunction
See Also:
Function.containsKey(Object)

containsValue

public boolean containsValue(byte v)
Specified by:
containsValue in interface Byte2ByteMap
See Also:
Map.containsValue(Object)

defaultReturnValue

public byte defaultReturnValue()
Description copied from interface: Byte2ByteFunction
Gets the default return value.

Specified by:
defaultReturnValue in interface Byte2ByteFunction
Overrides:
defaultReturnValue in class Byte2ByteFunctions.UnmodifiableFunction
Returns:
the current default return value.

defaultReturnValue

public void defaultReturnValue(byte defRetValue)
Description copied from interface: Byte2ByteFunction
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 Byte2ByteFunction
Overrides:
defaultReturnValue in class Byte2ByteFunctions.UnmodifiableFunction
Parameters:
defRetValue - the new default return value.
See Also:
Byte2ByteFunction.defaultReturnValue()

put

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

Specified by:
put in interface Byte2ByteFunction
Overrides:
put in class Byte2ByteFunctions.UnmodifiableFunction
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 Byte> m)
Specified by:
putAll in interface Map<Byte,Byte>

byte2ByteEntrySet

public ObjectSet<Byte2ByteMap.Entry> byte2ByteEntrySet()
Description copied from interface: Byte2ByteMap
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 Byte2ByteMap.entrySet() so that it returns an ObjectSet of objects of type Byte2ByteMap.Entry (the latter makes it possible to access keys and values with type-specific methods).

Specified by:
byte2ByteEntrySet in interface Byte2ByteMap
Returns:
a type-specific set view of the mappings contained in this map.
See Also:
Byte2ByteMap.entrySet()

keySet

public ByteSet keySet()
Description copied from interface: Byte2ByteMap
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 Byte2ByteMap
Specified by:
keySet in interface Map<Byte,Byte>
Returns:
a set view of the keys contained in this map.
See Also:
Map.keySet()

values

public ByteCollection values()
Description copied from interface: Byte2ByteMap
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 Byte2ByteMap
Specified by:
values in interface Map<Byte,Byte>
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,Byte>
Specified by:
clear in interface Map<Byte,Byte>
Overrides:
clear in class Byte2ByteFunctions.UnmodifiableFunction
See Also:
Map.clear()

toString

public String toString()
Overrides:
toString in class Byte2ByteFunctions.UnmodifiableFunction

put

public Byte put(Byte k,
                Byte v)
Description copied from class: AbstractByte2ByteFunction
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:
put in interface Function<Byte,Byte>
Specified by:
put in interface Map<Byte,Byte>
Overrides:
put in class AbstractByte2ByteFunction
Parameters:
k - the key.
v - the value.
Returns:
the old value, or null if no value was present for the given key.
See Also:
Map.put(Object,Object)

remove

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

Specified by:
remove in interface Byte2ByteFunction
Overrides:
remove in class Byte2ByteFunctions.UnmodifiableFunction
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 byte get(byte k)
Description copied from interface: Byte2ByteFunction
Returns the value to which the given key is mapped.

Specified by:
get in interface Byte2ByteFunction
Overrides:
get in class Byte2ByteFunctions.UnmodifiableFunction
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,Byte>
Specified by:
containsKey in interface Map<Byte,Byte>
Overrides:
containsKey in class Byte2ByteFunctions.UnmodifiableFunction
Parameters:
ok - the key.
Returns:
true if this function associates a value to key.
See Also:
Map.containsKey(Object)

containsValue

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

isEmpty

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

entrySet

public ObjectSet<Map.Entry<Byte,Byte>> entrySet()
Description copied from interface: Byte2ByteMap
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 Byte2ByteMap
Specified by:
entrySet in interface Map<Byte,Byte>
Returns:
a set view of the mappings contained in this map.
See Also:
Map.entrySet()


Copyright © 2011. All Rights Reserved.