List (Crater Dog Java Collection Framework 3.13 API)

java.lang.Object
- craterdog.smart.SmartObject<Sequence<E>>
- - craterdog.collections.abstractions.Sequence<E>
  - - craterdog.collections.abstractions.Collection<E>
    - - craterdog.collections.abstractions.OpenCollection<E>
      - craterdog.collections.abstractions.SortableCollection<E>
        
        craterdog.collections.List<E>

Type Parameters:

E - The type of element managed by the collection.

All Implemented Interfaces:

craterdog.core.Composite, craterdog.core.Sequential<E>, java.lang.Comparable<Sequence<E>>, java.lang.Iterable<E>
```
public class List<E>
extends SortableCollection<E>
```
This collection class implements a sortable list which performs very well for both inserts and indexed lookups of its values. The implementation dynamically scales up and down the size of the underlying data structures as the number of associations changes over time. The indexing is unit based and allows positive indexes starting at the beginning of the collection or negative indexes starting at the end of the collection as follows:
```
         1             2             3               N
    [element 1] . [element 2] . [element 3] ... [element N]
        -N          -(N-1)        -(N-2)            -1
 
```
Author:

Derk Norton

Constructor Summary

Constructors
Constructor and Description
`List()` This constructor creates a new empty list.
`List(Collection<? extends E> elements)` This constructor creates a new list using the elements provided in a collection.
`List(java.util.Collection<? extends E> elements)` This constructor creates a new list using the elements provided in a java collection.
`List(E[] elements)` This constructor creates a new list using the elements provided in an array.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addElement(E element)` This method adds a new element to the collection.
`static <E> List<E>`	`concatenation(List<E> list1, List<E> list2)` This function returns a new list that contains the all the elements from both the specified lists.
`List<E>`	`copy()`
`craterdog.core.Iterator<E>`	`createIterator()`
`craterdog.core.Manipulator<E>`	`createManipulator()` This method creates a new default manipulator for the collection.
`E`	`getElement(int index)` This method returns the element at the specified index.
`List<E>`	`getElements(int firstIndex, int lastIndex)` This method returns a collection of the elements in the specified index range.
`int`	`getIndex(E element)` This method return the index of the specified element, or zero if the element is not found.
`int`	`getSize()`
`void`	`insertElement(E element, int index)` This method inserts the specified element into the collection before the element associated with the specified index.
`void`	`insertElements(java.lang.Iterable<? extends E> elements, int index)` This method inserts the specified elements into the collection before the element associated with the specified index.
`void`	`removeAll()` This method removes all elements from the collection.
`boolean`	`removeElement(E element)` This method removes the specified element from the collection.
`E`	`removeElement(int index)` This method removes from the collection the element associated with the specified index.
`List<E>`	`removeElements(int firstIndex, int lastIndex)` This method removes from the collection the elements associated with the specified index range.
`E`	`replaceElement(E element, int index)` This method replaces an existing element in the collection with a new one.
`E[]`	`toArray()`

Methods inherited from class craterdog.collections.abstractions.SortableCollection
concatenate, shuffleElements, sortElements, sortElements, sortElements

Methods inherited from class craterdog.collections.abstractions.OpenCollection
addElements, addElements, removeElements, removeElements

Methods inherited from class craterdog.collections.abstractions.Collection
containsAll, containsAny, containsElement, normalizedIndex

Methods inherited from class craterdog.collections.abstractions.Sequence
compareTo, equals, hashCode

Methods inherited from class craterdog.smart.SmartObject
addSerializableClass, addSerializableClass, addSerializableClass, createMapper, fromString, fromString, toExposedString, toString, toString, toString, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface craterdog.core.Sequential
isEmpty, iterator

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - List
```
public List()
```
    This constructor creates a new empty list.
  - List
```
public List(E[] elements)
```
    This constructor creates a new list using the elements provided in an array.
    
    Parameters:
    
    elements - The elements that should be used to seed the list.
  - List
```
public List(Collection<? extends E> elements)
```
    This constructor creates a new list using the elements provided in a collection.
    
    Parameters:
    
    elements - The elements that should be used to seed the list.
  - List
```
public List(java.util.Collection<? extends E> elements)
```
    This constructor creates a new list using the elements provided in a java collection. In general it is confusing to mix java collections with craterdog collections since the former uses zero based indexing and the latter uses positive and negative ordinal based indexing.
    
    Parameters:
    
    elements - The elements that should be used to seed the list.
- Method Detail
  - toArray
```
public E[] toArray()
```
    Specified by:
    
    toArray in interface craterdog.core.Sequential<E>
    
    Overrides:
    
    toArray in class Sequence<E>
  - copy
```
public List<E> copy()
```
    Overrides:
    
    copy in class craterdog.smart.SmartObject<Sequence<E>>
  - getSize
```
public final int getSize()
```
  - getElement
```
public final E getElement(int index)
```
    Description copied from class: Collection
    
    This method returns the element at the specified index.
    
    Specified by:
    
    getElement in class Collection<E>
    
    Parameters:
    
    index - The index of the element to be returned.
    
    Returns:
    
    The element at the specified index.
  - getIndex
```
public final int getIndex(E element)
```
    Description copied from class: Collection
    
    This method return the index of the specified element, or zero if the element is not found.
    
    Specified by:
    
    getIndex in class Collection<E>
    
    Parameters:
    
    element - The element to be checked for in the collection.
    
    Returns:
    
    The index of the element of zero if the element was not found.
  - getElements
```
public final List<E> getElements(int firstIndex,
                                 int lastIndex)
```
    Description copied from class: Collection
    
    This method returns a collection of the elements in the specified index range.
    
    Specified by:
    
    getElements in class Collection<E>
    
    Parameters:
    
    firstIndex - The index of the first element to be returned.
    
    lastIndex - the index of the last element to be returned.
    
    Returns:
    
    A collection of elements in the specified range.
  - addElement
```
public final boolean addElement(E element)
```
    Description copied from class: OpenCollection
    
    This method adds a new element to the collection. If the collection is empty then the new element will be the first element in the collection.
    
    Specified by:
    
    addElement in class OpenCollection<E>
    
    Parameters:
    
    element - The new element to be added.
    
    Returns:
    
    Whether or not the element was actually added to the collection.
  - insertElement
```
public final void insertElement(E element,
                                int index)
```
    This method inserts the specified element into the collection before the element associated with the specified index.
    
    Parameters:
    
    element - The new element to be inserted into the collection.
    
    index - The index of the element before which the new element is to be inserted.
  - insertElements
```
public final void insertElements(java.lang.Iterable<? extends E> elements,
                                 int index)
```
    This method inserts the specified elements into the collection before the element associated with the specified index. The new elements are inserted in the same order as they appear in the specified list.
    
    Parameters:
    
    elements - The new elements to be inserted into the collection.
    
    index - The index of the element before which the new element is to be inserted.
  - replaceElement
```
public final E replaceElement(E element,
                              int index)
```
    This method replaces an existing element in the collection with a new one. The new element replaces the existing element at the specified index.
    
    Parameters:
    
    element - The new element that will replace the existing one.
    
    index - The index of the existing element.
    
    Returns:
    
    The element that was at the specified index.
  - removeElement
```
public final E removeElement(int index)
```
    This method removes from the collection the element associated with the specified index.
    
    Parameters:
    
    index - The index of the element to be removed.
    
    Returns:
    
    The element at the specified index.
  - removeElement
```
public final boolean removeElement(E element)
```
    Description copied from class: OpenCollection
    
    This method removes the specified element from the collection. If the element is not found in the collection, no changes are made.
    
    Specified by:
    
    removeElement in class OpenCollection<E>
    
    Parameters:
    
    element - The element to be removed.
    
    Returns:
    
    Whether or not the element was found.
  - removeElements
```
public final List<E> removeElements(int firstIndex,
                                    int lastIndex)
```
    This method removes from the collection the elements associated with the specified index range.
    
    Parameters:
    
    firstIndex - The index of the first element to be removed.
    
    lastIndex - The index of the last element to be removed.
    
    Returns:
    
    The list of the elements that were removed from the collection.
  - removeAll
```
public final void removeAll()
```
    Description copied from class: Collection
    
    This method removes all elements from the collection.
    
    Specified by:
    
    removeAll in class Collection<E>
  - createIterator
```
public craterdog.core.Iterator<E> createIterator()
```
  - createManipulator
```
public craterdog.core.Manipulator<E> createManipulator()
```
    Description copied from class: SortableCollection
    
    This method creates a new default manipulator for the collection.
    
    Specified by:
    
    createManipulator in class SortableCollection<E>
    
    Returns:
    
    The new manipulator.
  - concatenation
```
public static <E> List<E> concatenation(List<E> list1,
                                        List<E> list2)
```
    This function returns a new list that contains the all the elements from both the specified lists.
    
    Type Parameters:
    
    E - The type of element contained in the lists.
    
    Parameters:
    
    list1 - The first list whose elements are to be added.
    
    list2 - The second list whose elements are to be added.
    
    Returns:
    
    The resulting list.

Class List<E>

Constructor Summary

Method Summary

Methods inherited from class craterdog.collections.abstractions.SortableCollection

Methods inherited from class craterdog.collections.abstractions.OpenCollection

Methods inherited from class craterdog.collections.abstractions.Collection

Methods inherited from class craterdog.collections.abstractions.Sequence

Methods inherited from class craterdog.smart.SmartObject

Methods inherited from class java.lang.Object

Methods inherited from interface craterdog.core.Sequential

Methods inherited from interface java.lang.Iterable

Constructor Detail

List

List

List

List

Method Detail

toArray

copy

getSize

getElement

getIndex

getElements

addElement

insertElement

insertElements

replaceElement

removeElement

removeElement

removeElements

removeAll

createIterator

createManipulator

concatenation