org.magicwerk.brownies.collections

Class KeyListImpl<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

org.magicwerk.brownies.collections.IList<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 abstract class KeyListImpl<E>
extends IList<E>

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

Version:

$Id: KeyListImpl.java 3081 2016-01-05 00:29:01Z 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.
boolean	addIf(E elem) Adds element if allowed and returns true.
java.util.Set<E>	asSet() Returns a Set view of the element set.
<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 list.
void	clear()
java.lang.Object	clone() Returns a shallow copy of this list instance.
boolean	contains(java.lang.Object elem)
boolean	containsKey(int keyIndex, java.lang.Object key) Checks whether the specified key exists in this list.
KeyListImpl<E>	copy() Returns a shallow copy of this list instance.
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)
IList<E>	getAll(E elem) Returns all elements in the list equal to the specified element.
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	getCount(E elem) Counts how many times the specified element is contained in the list.
int	getCountByKey(int keyIndex, java.lang.Object key) Returns number of elements with specified key.
java.util.Set<E>	getDistinct() Returns distinct elements in the list.
java.util.Set<?>	getDistinctKeys(int keyIndex) Returns set containing all distinct keys.
IFunction<E,java.lang.Object>	getKeyMapper(int keyIndex) Returns mapper for specified key map.
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.
boolean	isSorted() Determines whether this list is sorted or not.
IList<E>	removeAll(E elem) Removes all equal elements.
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.
void	trimToSize() An application can use this operation to minimize the storage of an instance.

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

addAll, addAll, addAll, addAll, addArray, addArray, addFirst, addIfAbsent, addLast, addMult, addMult, binarySearch, containsAll, containsAny, copy, descendingIterator, drag, element, equals, extract, extractWhere, fill, filter, getAll, getArray, getFirst, getLast, getWhere, hashCode, indexOf, initAll, initAll, initArray, initMult, isEmpty, iterator, lastIndexOf, lastIndexOf, listIterator, listIterator, mappedList, move, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, put, putAll, putAll, putArray, putMult, remove, remove, remove, remove, removeAll, removeAll, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, removeWhere, replaceAll, replaceAll, replaceArray, replaceMult, resize, retainAll, retainAll, retainWhere, reverse, reverse, rotate, rotate, setAll, setAll, setArray, setMult, sort, swap, toArray, toArray, toArray, toString, transferCopy, transferMove, transferRemove, transferSwap, 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

clone

public java.lang.Object clone()

Description copied from class: IList

Returns a shallow copy of this list instance. (The elements themselves are not copied).

Overrides:

clone in class IList<E>

Returns:

a clone of this list instance

copy

public KeyListImpl<E> copy()

Description copied from class: IList

Returns a shallow copy of this list instance. (the new list will contain the same elements as the source list, i.e. the elements themselves are not copied). This method is identical to clone() except that the result is casted to an IList.

Overrides:

copy in class IList<E>

Returns:

a clone of this instance

See Also:

IList.clone()

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 list

asSet

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

Returns a Set view of the element set.

Returns:

set view

Throws:

java.lang.IllegalArgumentException - if the element set cannot be viewed as Set

isSorted

public boolean isSorted()

Determines whether this list is sorted or not.

Returns:

true if this a sorted list, false if not

capacity

public int capacity()

Description copied from class: IList

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

Specified by:

capacity in class IList<E>

Returns:

capacity of this list

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>

Specified by:

size in class IList<E>

get

public E get(int index)

Specified by:

get in interface java.util.List<E>

Overrides:

get in class IList<E>

contains

public boolean contains(java.lang.Object elem)

Specified by:

contains in interface java.util.Collection<E>

Specified by:

contains in interface java.util.Deque<E>

Specified by:

contains in interface java.util.List<E>

Overrides:

contains in class IList<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 IList<E>

addIf

public boolean addIf(E elem)

Adds element if allowed and returns true. If the element cannot be added (constraint violation like duplicated key), false is returned.

Parameters:

elem - element to add

Returns:

true if element has been added, false otherwise

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 IList<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 IList<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 IList<E>

ensureCapacity

public void ensureCapacity(int minCapacity)

Description copied from class: IList

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 IList<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 IList<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

getKeyMapper

public IFunction<E,java.lang.Object> getKeyMapper(int keyIndex)

Returns mapper for specified key map.

Parameters:

keyIndex - key index

Returns:

mapper for specified key map

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 elements

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 set 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: IList

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

Specified by:

binarySearch in class IList<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: IList

Sort specified elements in the list using the specified comparator.

Specified by:

sort in class IList<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[])

getAll

public IList<E> getAll(E elem)

Description copied from class: IList

Returns all elements in the list equal to the specified element.

Overrides:

getAll in class IList<E>

Parameters:

elem - element to look for

Returns:

all elements in the list equal to the specified element

getCount

public int getCount(E elem)

Description copied from class: IList

Counts how many times the specified element is contained in the list.

Overrides:

getCount in class IList<E>

Parameters:

elem - element to count

Returns:

count how many times the specified element is contained in the list

removeAll

public IList<E> removeAll(E elem)

Description copied from class: IList

Removes all equal elements.

Overrides:

removeAll in class IList<E>

Parameters:

elem - element

Returns:

removed equal elements (never null)

getDistinct

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

Description copied from class: IList

Returns distinct elements in the list.

Overrides:

getDistinct in class IList<E>

Returns:

distinct elements in the list

trimToSize

public void trimToSize()

Description copied from class: IList

An application can use this operation to minimize the storage of an instance.

Specified by:

trimToSize in class IList<E>