org.sonar.java.collections

Class AVLTree<K,V>

java.lang.Object

org.sonar.java.collections.AVLTree<K,V>

All Implemented Interfaces:

PMap<K,V>, PSet<K>

public abstract class AVLTree<K,V>
extends Object
implements PMap<K,V>, PSet<K>

AVL Tree. https://en.wikipedia.org/wiki/AVL_tree

Author:

Evgeny Mandrikov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AVLTree.Visitor<K,V>

Nested classes/interfaces inherited from interface org.sonar.java.collections.PMap

PMap.Consumer<K,V>

Nested classes/interfaces inherited from interface org.sonar.java.collections.PSet

PSet.Consumer<E>

Constructor Summary

Constructors

Constructor and Description
AVLTree()

Method Summary

Modifier and Type	Method and Description
AVLTree<K,V>	add(K e)
boolean	contains(K k)
static <K,V> AVLTree<K,V>	create()
Iterator<Map.Entry<K,V>>	entriesIterator() Iterates over all elements.
void	forEach(PMap.Consumer<K,V> consumer) Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.
void	forEach(PSet.Consumer<K> action) Performs the given action for each entry in this set until all elements have been processed or the action throws an exception.
V	get(K key)
protected abstract int	height()
protected abstract Object	key()
protected abstract AVLTree	left()
AVLTree<K,V>	put(K key, V value)
AVLTree<K,V>	remove(K key)
protected abstract AVLTree	right()
protected abstract Object	value()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.sonar.java.collections.PMap

isEmpty

Methods inherited from interface org.sonar.java.collections.PSet

isEmpty

Constructor Detail

AVLTree

public AVLTree()

Method Detail

create

public static <K,V> AVLTree<K,V> create()

Returns:

empty tree

add

public AVLTree<K,V> add(K e)

Specified by:

add in interface PSet<K>

Returns:

new set with added element, or this if element already in the set

contains

public boolean contains(K k)

Specified by:

contains in interface PSet<K>

Returns:

true if this set contains the specified element

put

public AVLTree<K,V> put(K key,
                        V value)

Specified by:

put in interface PMap<K,V>

Returns:

new map with added key-value pair

remove

public AVLTree<K,V> remove(K key)

Specified by:

remove in interface PMap<K,V>

Specified by:

remove in interface PSet<K>

Returns:

new map with removed key, or this if map does not contain given key

get

@Nullable
public V get(K key)

Specified by:

get in interface PMap<K,V>

Returns:

value associated with given key, or null if not found

forEach

public void forEach(PSet.Consumer<K> action)

Description copied from interface: PSet

Performs the given action for each entry in this set until all elements have been processed or the action throws an exception.

Specified by:

forEach in interface PSet<K>

forEach

public void forEach(PMap.Consumer<K,V> consumer)

Description copied from interface: PMap

Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.

Specified by:

forEach in interface PMap<K,V>

entriesIterator

public Iterator<Map.Entry<K,V>> entriesIterator()

Description copied from interface: PMap

Iterates over all elements.

Specified by:

entriesIterator in interface PMap<K,V>

left

protected abstract AVLTree left()

right

protected abstract AVLTree right()

key

protected abstract Object key()

value

protected abstract Object value()

height

protected abstract int height()