it.unimi.dsi.fastutil.objects
Class Object2ShortFunctions.UnmodifiableFunction<K>

java.lang.Object
  extended by it.unimi.dsi.fastutil.objects.AbstractObject2ShortFunction<K>
      extended by it.unimi.dsi.fastutil.objects.Object2ShortFunctions.UnmodifiableFunction<K>
All Implemented Interfaces:
Function<K,Short>, Object2ShortFunction<K>, Serializable
Direct Known Subclasses:
Object2ShortMaps.UnmodifiableMap
Enclosing class:
Object2ShortFunctions

public static class Object2ShortFunctions.UnmodifiableFunction<K>
extends AbstractObject2ShortFunction<K>
implements Serializable

An unmodifiable wrapper class for functions.

See Also:
Serialized Form

Field Summary
protected  Object2ShortFunction<K> function
           
static long serialVersionUID
           
 
Fields inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2ShortFunction
defRetValue
 
Constructor Summary
protected Object2ShortFunctions.UnmodifiableFunction(Object2ShortFunction<K> f)
           
 
Method Summary
 void clear()
          Removes all associations from this function (optional operation).
 boolean containsKey(Object k)
          Returns true if this function contains a mapping for the specified key.
 short defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(short defRetValue)
          Sets the default return value.
 short getShort(Object k)
          Returns the value to which the given key is mapped.
 short put(K k, short v)
          Adds a pair to the map.
 short removeShort(Object 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()
           
 
Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2ShortFunction
get, put, remove
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values

function

protected final Object2ShortFunction<K> function
Constructor Detail

Object2ShortFunctions.UnmodifiableFunction

protected Object2ShortFunctions.UnmodifiableFunction(Object2ShortFunction<K> f)
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<K,Short>
Returns:
the intended number of keys in this function, or -1 if that number is not available.

containsKey

public boolean containsKey(Object k)
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<K,Short>
Parameters:
k - the key.
Returns:
true if this function associates a value to key.
See Also:
Map.containsKey(Object)

defaultReturnValue

public short defaultReturnValue()
Description copied from interface: Object2ShortFunction
Gets the default return value.

Specified by:
defaultReturnValue in interface Object2ShortFunction<K>
Overrides:
defaultReturnValue in class AbstractObject2ShortFunction<K>
Returns:
the current default return value.

defaultReturnValue

public void defaultReturnValue(short defRetValue)
Description copied from interface: Object2ShortFunction
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 Object2ShortFunction<K>
Overrides:
defaultReturnValue in class AbstractObject2ShortFunction<K>
Parameters:
defRetValue - the new default return value.
See Also:
Object2ShortFunction.defaultReturnValue()

put

public short put(K k,
                 short v)
Description copied from interface: Object2ShortFunction
Adds a pair to the map.

Specified by:
put in interface Object2ShortFunction<K>
Overrides:
put in class AbstractObject2ShortFunction<K>
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)

clear

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

Specified by:
clear in interface Function<K,Short>
Overrides:
clear in class AbstractObject2ShortFunction<K>
See Also:
Map.clear()

toString

public String toString()
Overrides:
toString in class Object

removeShort

public short removeShort(Object k)
Description copied from interface: Object2ShortFunction
Removes the mapping with the given key.

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

getShort

public short getShort(Object k)
Description copied from interface: Object2ShortFunction
Returns the value to which the given key is mapped.

Specified by:
getShort in interface Object2ShortFunction<K>
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)


Copyright © 2011. All Rights Reserved.