org.apache.hadoop.hbase.util
Class SortedList<E>

java.lang.Object
  extended by org.apache.hadoop.hbase.util.SortedList<E>
All Implemented Interfaces:
Iterable<E>, Collection<E>, List<E>, RandomAccess

public class SortedList<E>
extends Object
implements List<E>, RandomAccess

Simple sorted list implementation that uses ArrayList as the underlying collection so we can support RandomAccess. All mutations create a new copy of the ArrayList instance, so can be expensive. This class is only intended for use on small, very rarely written collections that expect highly concurrent reads.

Read operations are performed on a reference to the internal list at the time of invocation, so will not see any mutations to the collection during their operation. Iterating over list elements manually using the RandomAccess pattern involves multiple operations. For this to be safe get a reference to the internal list first using get().

If constructed with a Comparator, the list will be sorted using the comparator. Adding or changing an element using an index will trigger a resort.

Iterators are read-only. They cannot be used to remove elements.


Constructor Summary
SortedList(Collection<? extends E> c, Comparator<? super E> comparator)
          Constructs a list containing the elements of the given collection, in the order returned by the collection's iterator, that will be sorted with the given comparator.
SortedList(Comparator<? super E> comparator)
          Constructs an empty list with the default initial capacity that will be sorted using the given comparator.
 
Method Summary
 boolean add(E e)
           
 void add(int index, E element)
           
 boolean addAll(Collection<? extends E> c)
           
 boolean addAll(int index, Collection<? extends E> c)
           
 void clear()
           
 boolean contains(Object o)
           
 boolean containsAll(Collection<?> c)
           
 List<E> get()
          Returns a reference to the unmodifiable list currently backing the SortedList.
 E get(int index)
           
 int indexOf(Object o)
           
 boolean isEmpty()
           
 Iterator<E> iterator()
           
 int lastIndexOf(Object o)
           
 ListIterator<E> listIterator()
           
 ListIterator<E> listIterator(int index)
           
 E remove(int index)
           
 boolean remove(Object o)
           
 boolean removeAll(Collection<?> c)
           
 boolean retainAll(Collection<?> c)
           
 E set(int index, E element)
           
 int size()
           
 List<E> subList(int fromIndex, int toIndex)
           
 Object[] toArray()
           
<T> T[]
toArray(T[] a)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.List
equals, hashCode
 

Constructor Detail

SortedList

public SortedList(Comparator<? super E> comparator)
Constructs an empty list with the default initial capacity that will be sorted using the given comparator.

Parameters:
comparator - the comparator

SortedList

public SortedList(Collection<? extends E> c,
                  Comparator<? super E> comparator)
Constructs a list containing the elements of the given collection, in the order returned by the collection's iterator, that will be sorted with the given comparator.

Parameters:
c - the collection
comparator - the comparator
Method Detail

get

public List<E> get()
Returns a reference to the unmodifiable list currently backing the SortedList. Changes to the SortedList will not be reflected in this list. Use this method to get a reference for iterating over using the RandomAccess pattern.


size

public int size()
Specified by:
size in interface Collection<E>
Specified by:
size in interface List<E>

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Collection<E>
Specified by:
isEmpty in interface List<E>

contains

public boolean contains(Object o)
Specified by:
contains in interface Collection<E>
Specified by:
contains in interface List<E>

iterator

public Iterator<E> iterator()
Specified by:
iterator in interface Iterable<E>
Specified by:
iterator in interface Collection<E>
Specified by:
iterator in interface List<E>

toArray

public Object[] toArray()
Specified by:
toArray in interface Collection<E>
Specified by:
toArray in interface List<E>

toArray

public <T> T[] toArray(T[] a)
Specified by:
toArray in interface Collection<E>
Specified by:
toArray in interface List<E>

add

public boolean add(E e)
Specified by:
add in interface Collection<E>
Specified by:
add in interface List<E>

remove

public boolean remove(Object o)
Specified by:
remove in interface Collection<E>
Specified by:
remove in interface List<E>

containsAll

public boolean containsAll(Collection<?> c)
Specified by:
containsAll in interface Collection<E>
Specified by:
containsAll in interface List<E>

addAll

public boolean addAll(Collection<? extends E> c)
Specified by:
addAll in interface Collection<E>
Specified by:
addAll in interface List<E>

addAll

public boolean addAll(int index,
                      Collection<? extends E> c)
Specified by:
addAll in interface List<E>

removeAll

public boolean removeAll(Collection<?> c)
Specified by:
removeAll in interface Collection<E>
Specified by:
removeAll in interface List<E>

retainAll

public boolean retainAll(Collection<?> c)
Specified by:
retainAll in interface Collection<E>
Specified by:
retainAll in interface List<E>

clear

public void clear()
Specified by:
clear in interface Collection<E>
Specified by:
clear in interface List<E>

get

public E get(int index)
Specified by:
get in interface List<E>

set

public E set(int index,
             E element)
Specified by:
set in interface List<E>

add

public void add(int index,
                E element)
Specified by:
add in interface List<E>

remove

public E remove(int index)
Specified by:
remove in interface List<E>

indexOf

public int indexOf(Object o)
Specified by:
indexOf in interface List<E>

lastIndexOf

public int lastIndexOf(Object o)
Specified by:
lastIndexOf in interface List<E>

listIterator

public ListIterator<E> listIterator()
Specified by:
listIterator in interface List<E>

listIterator

public ListIterator<E> listIterator(int index)
Specified by:
listIterator in interface List<E>

subList

public List<E> subList(int fromIndex,
                       int toIndex)
Specified by:
subList in interface List<E>


Copyright © 2007–2016 The Apache Software Foundation. All rights reserved.