org.magicwerk.brownies.collections

Class KeyListImpl<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

org.magicwerk.brownies.collections.GapList<E>

org.magicwerk.brownies.collections.KeyListImpl<E>

Type Parameters:

E - type of elements stored in the list

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.Deque<E>, java.util.List<E>, java.util.Queue<E>, java.util.RandomAccess

Direct Known Subclasses:

Key1List, Key2List, KeyList

public class KeyListImpl<E>
extends GapList<E>

A KeyList add key handling features to GapList. It is the abstract base class for both SetList and MapList.

Version:

$Id: KeyListImpl.java 1969 2013-10-21 23:25:30Z origo $

Author:

Thomas Mauch

See Also:

GapList, Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(E elem) Note that the behavior of the operation depends on the defined constraints.
void	add(int index, E elem) Note that the behavior of the operation depends on the defined constraints.
java.util.Set<E>	asSet() Returns a set view of the collection.
<K> int	binarySearch(int index, int len, K key, java.util.Comparator<? super K> comparator) Searches the specified range for an object using the binary search algorithm.
int	capacity() Returns capacity of this GapList.
void	clear()
boolean	containsKey(int keyIndex, java.lang.Object key) Checks whether the specified key exists in this list.
static <E> GapList<E>	create() Do not use.
static <E> GapList<E>	create(java.util.Collection<? extends E> coll) Do not use.
static <E> GapList<E>	create(E... elems) Do not use.
static <E> GapList<E>	create(int capacity) Do not use.
KeyListImpl<E>	crop() Returns a copy this list but without elements.
void	ensureCapacity(int minCapacity) Increases the capacity of this GapList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
E	get(int index)
GapList<E>	getAllByKey(int keyIndex, java.lang.Object key) Returns a list with all elements with the specified key.
E	getByKey(int keyIndex, java.lang.Object key) Returns value for given key.
int	getCountByKey(int keyIndex, java.lang.Object key) Returns number of elements with specified key.
java.util.Set<?>	getDistinctKeys(int keyIndex) Returns list containing all distinct keys.
int	indexOf(java.lang.Object elem)
int	indexOfKey(int keyIndex, java.lang.Object key) Find given key and return its index.
int	indexOfKey(int keyIndex, java.lang.Object key, int start) Find given key and return its index.
E	set(int index, E elem) Note that the behavior of the operation depends on the defined constraints.
int	size()
void	sort(int index, int len, java.util.Comparator<? super E> comparator) Sort specified elements in the list using the specified comparator.

Methods inherited from class org.magicwerk.brownies.collections.GapList

addAll, addAll, addAll, addAll, addAll, addAll, addFirst, addLast, binarySearch, clone, contains, containsAll, containsAny, copy, copy, copy, descendingIterator, element, EMPTY, equals, fill, fill, getAll, getArray, getFirst, getLast, hashCode, init, init, init, init, init, isEmpty, iterator, lastIndexOf, listIterator, listIterator, move, move, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, remove, remove, removeAll, removeAll, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, resize, retainAll, retainAll, reverse, reverse, rotate, rotate, setAll, setAll, setAll, sort, swap, swap, toArray, toArray, toArray, toString, trimToSize, unmodifiableList

Methods inherited from class java.util.AbstractList

subList

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

subList

Method Detail

create

public static <E> GapList<E> create()

Do not use. Use Builder instead.

create

public static <E> GapList<E> create(int capacity)

Do not use. Use Builder instead.

create

public static <E> GapList<E> create(java.util.Collection<? extends E> coll)

Do not use. Use Builder instead.

create

public static <E> GapList<E> create(E... elems)

Do not use. Use Builder instead.

asSet

public java.util.Set<E> asSet()

Returns a set view of the collection. Note that this method does not check whether the collection really is really a set as defined by the Set interface. It makes only sure that the add() method will return false instead of throwing a DuplicateKeyException.

Returns:

set view

capacity

public int capacity()

Description copied from class: GapList

Returns capacity of this GapList. Note that two GapLists are considered equal even if they have a distinct capacity. Also the capacity can be changed by operations like clone() etc.

Overrides:

capacity in class GapList<E>

Returns:

capacity of this GapList

size

public int size()

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in interface java.util.Deque<E>

Specified by:

size in interface java.util.List<E>

Overrides:

size in class GapList<E>

get

public E get(int index)

Specified by:

get in interface java.util.List<E>

Overrides:

get in class GapList<E>

add

public boolean add(E elem)

Note that the behavior of the operation depends on the defined constraints.

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.Deque<E>

Specified by:

add in interface java.util.List<E>

Specified by:

add in interface java.util.Queue<E>

Overrides:

add in class GapList<E>

add

public void add(int index,
       E elem)

Note that the behavior of the operation depends on the defined constraints.

Specified by:

add in interface java.util.List<E>

Overrides:

add in class GapList<E>

set

public E set(int index,
    E elem)

Note that the behavior of the operation depends on the defined constraints.

Specified by:

set in interface java.util.List<E>

Overrides:

set in class GapList<E>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.List<E>

Overrides:

clear in class GapList<E>

crop

public KeyListImpl<E> crop()

Returns a copy this list but without elements. The new list will use the same comparator, ordering, etc.

Returns:

an empty copy of this instance

ensureCapacity

public void ensureCapacity(int minCapacity)

Description copied from class: GapList

Increases the capacity of this GapList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.

Overrides:

ensureCapacity in class GapList<E>

Parameters:

minCapacity - the desired minimum capacity

indexOf

public int indexOf(java.lang.Object elem)

Specified by:

indexOf in interface java.util.List<E>

Overrides:

indexOf in class GapList<E>

indexOfKey

public int indexOfKey(int keyIndex,
             java.lang.Object key)

Find given key and return its index.

Parameters:

keyIndex - key index

key - key to find

Returns:

index of key or -1 if not found

indexOfKey

public int indexOfKey(int keyIndex,
             java.lang.Object key,
             int start)

Find given key and return its index.

Parameters:

keyIndex - key index

key - key to find

start - start index for search

Returns:

index of key or -1 if not found

containsKey

public boolean containsKey(int keyIndex,
                  java.lang.Object key)

Checks whether the specified key exists in this list.

Parameters:

keyIndex - key index

key - key to look for

Returns:

true if the key exists, otherwise false

getByKey

public E getByKey(int keyIndex,
         java.lang.Object key)

Returns value for given key. If there are several values for this key, the first is returned. If the key is not found, null is returned.

Parameters:

keyIndex - key index

key - key to find

Returns:

value of specified key or null

getAllByKey

public GapList<E> getAllByKey(int keyIndex,
                     java.lang.Object key)

Returns a list with all elements with the specified key.

Parameters:

keyIndex - key index

key - key which elements must have

Returns:

list with all keys (null if key is null)

getCountByKey

public int getCountByKey(int keyIndex,
                java.lang.Object key)

Returns number of elements with specified key.

Parameters:

keyIndex - key index

key - key which elements must have

Returns:

number of elements with key

getDistinctKeys

public java.util.Set<?> getDistinctKeys(int keyIndex)

Returns list containing all distinct keys.

Parameters:

keyIndex - key index

Returns:

list containing all distinct keys

binarySearch

public <K> int binarySearch(int index,
                   int len,
                   K key,
                   java.util.Comparator<? super K> comparator)

Description copied from class: GapList

Searches the specified range for an object using the binary search algorithm.

Overrides:

binarySearch in class GapList<E>

Parameters:

index - index of first element to search

len - number of elements to search

key - the value to be searched for

comparator - the comparator by which the list is ordered. A null value indicates that the elements' natural ordering should be used.

Returns:

index of the search key, if it is contained in the array; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted into the array: the index of the first element greater than the key, or a.length if all elements in the array are less than the specified key. Note that this guarantees that the return value will be >= 0 if and only if the key is found.

See Also:

Arrays.binarySearch(long[], long)

sort

public void sort(int index,
        int len,
        java.util.Comparator<? super E> comparator)

Description copied from class: GapList

Sort specified elements in the list using the specified comparator.

Overrides:

sort in class GapList<E>

Parameters:

index - index of first element to sort

len - number of elements to sort

comparator - comparator to use for sorting (null means the elements natural ordering should be used)

See Also:

Arrays.sort(int[])