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

java.lang.Object
  extended by it.unimi.dsi.fastutil.objects.AbstractReference2IntFunction<K>
      extended by it.unimi.dsi.fastutil.objects.Reference2IntFunctions.UnmodifiableFunction<K>
All Implemented Interfaces:
Function<K,Integer>, Reference2IntFunction<K>, Serializable
Direct Known Subclasses:
Reference2IntMaps.UnmodifiableMap
Enclosing class:
Reference2IntFunctions

public static class Reference2IntFunctions.UnmodifiableFunction<K>
extends AbstractReference2IntFunction<K>
implements Serializable

An unmodifiable wrapper class for functions.

See Also:
Serialized Form

Field Summary
protected  Reference2IntFunction<K> function
           
static long serialVersionUID
           
 
Fields inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2IntFunction
defRetValue
 
Constructor Summary
protected Reference2IntFunctions.UnmodifiableFunction(Reference2IntFunction<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.
 int defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(int defRetValue)
          Sets the default return value.
 int getInt(Object k)
          Returns the value to which the given key is mapped.
 int put(K k, int v)
          Adds a pair to the map.
 int removeInt(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.AbstractReference2IntFunction
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 Reference2IntFunction<K> function
Constructor Detail

Reference2IntFunctions.UnmodifiableFunction

protected Reference2IntFunctions.UnmodifiableFunction(Reference2IntFunction<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,Integer>
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,Integer>
Parameters:
k - the key.
Returns:
true if this function associates a value to key.
See Also:
Map.containsKey(Object)

defaultReturnValue

public int defaultReturnValue()
Description copied from interface: Reference2IntFunction
Gets the default return value.

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

defaultReturnValue

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

put

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

Specified by:
put in interface Reference2IntFunction<K>
Overrides:
put in class AbstractReference2IntFunction<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,Integer>
Overrides:
clear in class AbstractReference2IntFunction<K>
See Also:
Map.clear()

toString

public String toString()
Overrides:
toString in class Object

removeInt

public int removeInt(Object k)
Description copied from interface: Reference2IntFunction
Removes the mapping with the given key.

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

getInt

public int getInt(Object k)
Description copied from interface: Reference2IntFunction
Returns the value to which the given key is mapped.

Specified by:
getInt in interface Reference2IntFunction<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.