it.unimi.dsi.fastutil.shorts
Class Short2ByteFunctions.UnmodifiableFunction

java.lang.Object
  extended by it.unimi.dsi.fastutil.shorts.AbstractShort2ByteFunction
      extended by it.unimi.dsi.fastutil.shorts.Short2ByteFunctions.UnmodifiableFunction
All Implemented Interfaces:
Function<Short,Byte>, Short2ByteFunction, Serializable
Direct Known Subclasses:
Short2ByteMaps.UnmodifiableMap
Enclosing class:
Short2ByteFunctions

public static class Short2ByteFunctions.UnmodifiableFunction
extends AbstractShort2ByteFunction
implements Serializable

An unmodifiable wrapper class for functions.

See Also:
Serialized Form

Field Summary
protected  Short2ByteFunction function
           
static long serialVersionUID
           
 
Fields inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2ByteFunction
defRetValue
 
Constructor Summary
protected Short2ByteFunctions.UnmodifiableFunction(Short2ByteFunction f)
           
 
Method Summary
 void clear()
          Removes all associations from this function (optional operation).
 boolean containsKey(Object ok)
          Returns true if this function contains a mapping for the specified key.
 boolean containsKey(short k)
           
 byte defaultReturnValue()
          Gets the default return value.
 void defaultReturnValue(byte defRetValue)
          Sets the default return value.
 byte get(short k)
          Returns the value to which the given key is mapped.
 byte put(short k, byte v)
          Adds a pair to the map.
 byte remove(short 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.shorts.AbstractShort2ByteFunction
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 Short2ByteFunction function
Constructor Detail

Short2ByteFunctions.UnmodifiableFunction

protected Short2ByteFunctions.UnmodifiableFunction(Short2ByteFunction 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<Short,Byte>
Returns:
the intended number of keys in this function, or -1 if that number is not available.

containsKey

public boolean containsKey(short k)
Specified by:
containsKey in interface Short2ByteFunction
See Also:
Function.containsKey(Object)

defaultReturnValue

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

Specified by:
defaultReturnValue in interface Short2ByteFunction
Overrides:
defaultReturnValue in class AbstractShort2ByteFunction
Returns:
the current default return value.

defaultReturnValue

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

put

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

Specified by:
put in interface Short2ByteFunction
Overrides:
put in class AbstractShort2ByteFunction
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<Short,Byte>
Overrides:
clear in class AbstractShort2ByteFunction
See Also:
Map.clear()

toString

public String toString()
Overrides:
toString in class Object

remove

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

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

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


Copyright © 2011. All Rights Reserved.