ContainmentList (Scribble::Docs::Javadoc 0.3.0.Final API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<E>
  - - java.util.Vector<E>
    - - org.scribble.model.ContainmentList<E>

Type Parameters:
E - The element type

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Collection<E>, List<E>, RandomAccess
```
public class ContainmentList<E extends ModelObject>
extends Vector<E>
implements List<E>
```
This class represents a list that understands how to manage containment and parent relationships.

See Also:
Serialized Form

Field Summary
- Fields inherited from class java.util.Vector
  capacityIncrement, elementCount, elementData
- Fields inherited from class java.util.AbstractList
  modCount

Constructor Summary

Constructors
Constructor and Description

ContainmentList(ModelObject parent, Class<E> type)
This is the constructor for the containment list.

Constructors
Constructor and Description
`ContainmentList(ModelObject parent, Class<E> type)` This is the constructor for the containment list.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(E o)` Appends the specified element to the end of this list (optional operation).
`void`	`add(int index, E element)` Inserts the specified element at the specified position in this list (optional operation).
`boolean`	`addAll(Collection<? extends E> c)` Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation).
`boolean`	`addAll(int index, Collection<? extends E> c)` Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
`void`	`clear()` Removes all of the elements from this list (optional operation).
`Class<E>`	`getType()` This method returns the base type associated with the list elements.
`E`	`remove(int index)` Removes the element at the specified position in this list (optional operation).
`boolean`	`remove(Object o)` Removes the first occurrence in this list of the specified element (optional operation).
`boolean`	`removeAll(Collection<?> c)` Removes from this list all the elements that are contained in the specified collection (optional operation).
`boolean`	`retainAll(Collection<?> c)` Retains only the elements in this list that are contained in the specified collection (optional operation).
`E`	`set(int index, E element)` Replaces the element at the specified position in this list with the specified element (optional operation).

Methods inherited from class java.util.Vector
addElement, capacity, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, listIterator, listIterator, removeAllElements, removeElement, removeElementAt, removeRange, setElementAt, setSize, size, subList, toArray, toArray, toString, trimToSize

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

Methods inherited from interface java.util.List
contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, size, subList, toArray, toArray

- Constructor Detail
  - ContainmentList
```
public ContainmentList(ModelObject parent,
               Class<E> type)
```
    This is the constructor for the containment list.
    
    Parameters:
    parent - The parent model object
    type - The type of the elements in the list
- Method Detail
  - getType
```
public Class<E> getType()
```
    This method returns the base type associated with the list elements.
    
    Returns:
    The base type for the list elements
  - add
```
public boolean add(E o)
```
    Appends the specified element to the end of this list (optional operation).
    Lists that support this operation may place limitations on what elements may be added to this list. In particular, some lists will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. List classes should clearly specify in their documentation any restrictions on what elements may be added.
    
    Specified by:
    
    add in interface Collection<E extends ModelObject>
    
    Specified by:
    
    add in interface List<E extends ModelObject>
    
    Overrides:
    
    add in class Vector<E extends ModelObject>
    
    Parameters:
    o - element to be appended to this list.
    
    Returns:
    true (as per the general contract of the Collection.add method).
  - remove
```
public boolean remove(Object o)
```
    Removes the first occurrence in this list of the specified element (optional operation). If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))) (if such an element exists).
    
    Specified by:
    
    remove in interface Collection<E extends ModelObject>
    
    Specified by:
    
    remove in interface List<E extends ModelObject>
    
    Overrides:
    
    remove in class Vector<E extends ModelObject>
    
    Parameters:
    o - element to be removed from this list, if present.
    
    Returns:
    true if this list contained the specified element.
  - addAll
```
public boolean addAll(Collection<? extends E> c)
```
    Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation). The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)
    
    Specified by:
    
    addAll in interface Collection<E extends ModelObject>
    
    Specified by:
    
    addAll in interface List<E extends ModelObject>
    
    Overrides:
    
    addAll in class Vector<E extends ModelObject>
    
    Parameters:
    c - collection whose elements are to be added to this list.
    
    Returns:
    true if this list changed as a result of the call.
    See Also:
    Vector.add(Object)
  - addAll
```
public boolean addAll(int index,
             Collection<? extends E> c)
```
    Inserts all of the elements in the specified collection into this list at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)
    
    Specified by:
    
    addAll in interface List<E extends ModelObject>
    
    Overrides:
    
    addAll in class Vector<E extends ModelObject>
    
    Parameters:
    index - index at which to insert first element from the specified collection.
    c - elements to be inserted into this list.
    
    Returns:
    true if this list changed as a result of the call.
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Removes from this list all the elements that are contained in the specified collection (optional operation).
    
    Specified by:
    
    removeAll in interface Collection<E extends ModelObject>
    
    Specified by:
    
    removeAll in interface List<E extends ModelObject>
    
    Overrides:
    
    removeAll in class Vector<E extends ModelObject>
    
    Parameters:
    c - collection that defines which elements will be removed from this list.
    
    Returns:
    true if this list changed as a result of the call.
    See Also:
    remove(Object), Vector.contains(Object)
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Retains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all the elements that are not contained in the specified collection.
    
    Specified by:
    
    retainAll in interface Collection<E extends ModelObject>
    
    Specified by:
    
    retainAll in interface List<E extends ModelObject>
    
    Overrides:
    
    retainAll in class Vector<E extends ModelObject>
    
    Parameters:
    c - collection that defines which elements this set will retain.
    
    Returns:
    true if this list changed as a result of the call.
    See Also:
    remove(Object), Vector.contains(Object)
  - clear
```
public void clear()
```
    Removes all of the elements from this list (optional operation). This list will be empty after this call returns (unless it throws an exception).
    
    Specified by:
    
    clear in interface Collection<E extends ModelObject>
    
    Specified by:
    
    clear in interface List<E extends ModelObject>
    
    Overrides:
    
    clear in class Vector<E extends ModelObject>
  - set
```
public E set(int index,
    E element)
```
    Replaces the element at the specified position in this list with the specified element (optional operation).
    
    Specified by:
    
    set in interface List<E extends ModelObject>
    
    Overrides:
    
    set in class Vector<E extends ModelObject>
    
    Parameters:
    index - index of element to replace.
    element - element to be stored at the specified position.
    
    Returns:
    the element previously at the specified position.
  - add
```
public void add(int index,
       E element)
```
    Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
    
    Specified by:
    
    add in interface List<E extends ModelObject>
    
    Overrides:
    
    add in class Vector<E extends ModelObject>
    
    Parameters:
    index - index at which the specified element is to be inserted.
    element - element to be inserted.
  - remove
```
public E remove(int index)
```
    Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.
    
    Specified by:
    
    remove in interface List<E extends ModelObject>
    
    Overrides:
    
    remove in class Vector<E extends ModelObject>
    
    Parameters:
    index - the index of the element to removed.
    
    Returns:
    the element previously at the specified position.

Class ContainmentList<E extends ModelObject>

Field Summary

Fields inherited from class java.util.Vector

Fields inherited from class java.util.AbstractList

Constructor Summary

Method Summary

Methods inherited from class java.util.Vector

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Constructor Detail

ContainmentList

Method Detail

getType

add

remove

addAll

addAll

removeAll

retainAll

clear

set

add

remove