Package com.intellij.util.keyFMap

Class ArrayBackedFMap

java.lang.Object

com.intellij.util.keyFMap.ArrayBackedFMap

All Implemented Interfaces:

KeyFMap

public class ArrayBackedFMap
extends java.lang.Object
implements KeyFMap

Field Summary

Fields inherited from interface com.intellij.util.keyFMap.KeyFMap

EMPTY_MAP

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
boolean	equalsByReference(KeyFMap o) Checks if other KeyFMap equals to this, assuming reference equality for the values
<V> V	get(Key<V> key) Returns a value associated with given key in this KeyFMap, or null if no value is associated.
Key []	getKeys()
int	getValueIdentityHashCode()
int	hashCode()
boolean	isEmpty()
KeyFMap	minus(Key<?> key) Returns a KeyFMap which consists of the same elements as this KeyFMap, except the supplied key which is removed.
<V> KeyFMap	plus(Key<V> key, V value) Returns a KeyFMap which consists of the same elements as this KeyFMap, but the key key is associated with the supplied value.
int	size()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

plus

public <V> KeyFMap plus(Key<V> key,
                        V value)

Description copied from interface: KeyFMap

Returns a KeyFMap which consists of the same elements as this KeyFMap, but the key key is associated with the supplied value. May return itself if the key is already associated with the supplied value.

Specified by:

plus in interface KeyFMap

Type Parameters:

V - a type of the value

Parameters:

key - a key to add or replace

value - a value to be associated with the key

Returns:

an updated KeyFMap (this or newly created)

size

public int size()

Specified by:

size in interface KeyFMap

Returns:

size (number of keys) of this KeyFMap.

minus

public KeyFMap minus(Key<?> key)

Description copied from interface: KeyFMap

Returns a KeyFMap which consists of the same elements as this KeyFMap, except the supplied key which is removed. May return itself if the supplied key is absent in this map.

Specified by:

minus in interface KeyFMap

Parameters:

key - a key to remove

Returns:

an updated KeyFMap

get

public <V> V get(Key<V> key)

Description copied from interface: KeyFMap

Returns a value associated with given key in this KeyFMap, or null if no value is associated. Note that unlike HashMap KeyFMap cannot hold null values.

Specified by:

get in interface KeyFMap

Type Parameters:

V - a type of the value

Parameters:

key - a key to get the value associated with

Returns:

a value associated with given key or null if there's no such value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface KeyFMap

Returns:

true if this KeyFMap is empty.

getValueIdentityHashCode

public int getValueIdentityHashCode()

Specified by:

getValueIdentityHashCode in interface KeyFMap

Returns:

a hashCode function for this map which uses System.identityHashCode(Object) for values.

getKeys

public Key [] getKeys()

Specified by:

getKeys in interface KeyFMap

Returns:

an array of all keys present in this KeyFMap, in no particular order. The length of the array equals to KeyFMap size.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

equalsByReference

public boolean equalsByReference(KeyFMap o)

Description copied from interface: KeyFMap

Checks if other KeyFMap equals to this, assuming reference equality for the values

Specified by:

equalsByReference in interface KeyFMap

Parameters:

o - KeyFMap to compare with

Returns:

true if other map equals to this map.