Collection (Crater Dog Java Collection Framework 3.3 API)

java.lang.Object
- craterdog.collections.abstractions.Collection<E>

Type Parameters:

E - The type of element managed by the collection.

All Implemented Interfaces:

Accessible<E>, Iteratable<E>, Composite, Sequential<E>, java.lang.Iterable<E>

Direct Known Subclasses:

OrderedCollection, SortableCollection
```
public abstract class Collection<E>
extends java.lang.Object
implements Accessible<E>
```
This abstract class defines the invariant methods that all collections must inherit.

Author:

Derk Norton

Constructor Summary

Constructors
Constructor and Description

Collection()

Constructors
Constructor and Description
`Collection()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addElements(E[] elements)` This method adds an array of new elements to the collection.
`int`	`addElements(java.lang.Iterable<? extends E> elements)` This method adds a list of new elements to the collection.
`boolean`	`containsAllElementsIn(java.lang.Iterable<? extends E> collection)` This method determines whether all of the specified elements are contained in the collection.
`boolean`	`containsAnyElementsIn(java.lang.Iterable<? extends E> collection)` This method determines whether any of the specified elements are contained in the collection.
`boolean`	`equals(java.lang.Object obj)`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`Iterator<E>`	`iterator()`
`protected int`	`normalizedIndex(int index)` This method converts negative indexes into their corresponding positive indexes and then checks to make sure the index is in the range [1..size].
`int`	`removeElements(E[] elements)` This method removes the elements in the specified array from the collection.
`int`	`removeElements(java.lang.Iterable<? extends E> elements)` This method removes the specified elements from the collection.
`void`	`toArray(E[] array)`
`java.lang.String`	`toString()`
`java.lang.String`	`toString(java.lang.String indentation)`

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

Methods inherited from interface craterdog.collections.interfaces.Accessible
addElement, containsElement, removeElement

Methods inherited from interface craterdog.collections.interfaces.Iteratable
createDefaultIterator, removeAllElements

Methods inherited from interface craterdog.core.Sequential
getNumberOfElements

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

- Constructor Detail
  - Collection
```
public Collection()
```
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public java.lang.String toString(java.lang.String indentation)
```
    Specified by:
    
    toString in interface Composite
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - isEmpty
```
public final boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Sequential<E>
  - toArray
```
public final void toArray(E[] array)
```
    Specified by:
    
    toArray in interface Sequential<E>
  - containsAnyElementsIn
```
public final boolean containsAnyElementsIn(java.lang.Iterable<? extends E> collection)
```
    Description copied from interface: Accessible
    
    This method determines whether any of the specified elements are contained in the collection.
    
    Specified by:
    
    containsAnyElementsIn in interface Accessible<E>
    
    Parameters:
    
    collection - The elements to be checked for in the collection.
    
    Returns:
    
    Whether or not any of the specified elements are contained in the collection.
  - containsAllElementsIn
```
public final boolean containsAllElementsIn(java.lang.Iterable<? extends E> collection)
```
    Description copied from interface: Accessible
    
    This method determines whether all of the specified elements are contained in the collection.
    
    Specified by:
    
    containsAllElementsIn in interface Accessible<E>
    
    Parameters:
    
    collection - The elements to be checked for in the collection.
    
    Returns:
    
    Whether or not all of the specified elements are contained in the collection.
  - addElements
```
public final int addElements(E[] elements)
```
    Description copied from interface: Accessible
    
    This method adds an array of new elements to the collection. The new elements will be added in the order they appear in the specified array.
    
    Specified by:
    
    addElements in interface Accessible<E>
    
    Parameters:
    
    elements - The array of new elements to be added.
    
    Returns:
    
    The number of elements that were actually added to the collection.
  - addElements
```
public final int addElements(java.lang.Iterable<? extends E> elements)
```
    Description copied from interface: Accessible
    
    This method adds a list of new elements to the collection. The new elements will be added in the order they appear in the specified collection.
    
    Specified by:
    
    addElements in interface Accessible<E>
    
    Parameters:
    
    elements - The list of new elements to be added.
    
    Returns:
    
    The number of elements that were actually added to the collection.
  - removeElements
```
public final int removeElements(E[] elements)
```
    Description copied from interface: Accessible
    
    This method removes the elements in the specified array from the collection. The number of matching elements is returned.
    
    Specified by:
    
    removeElements in interface Accessible<E>
    
    Parameters:
    
    elements - The array of elements to be removed from the collection.
    
    Returns:
    
    The number of elements that were actually removed.
  - removeElements
```
public final int removeElements(java.lang.Iterable<? extends E> elements)
```
    Description copied from interface: Accessible
    
    This method removes the specified elements from the collection. The number of matching elements is returned.
    
    Specified by:
    
    removeElements in interface Accessible<E>
    
    Parameters:
    
    elements - The list of elements to be removed from the collection.
    
    Returns:
    
    The number of elements that were actually removed.
  - iterator
```
public final Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Sequential<E>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
  - normalizedIndex
```
protected final int normalizedIndex(int index)
```
    This method converts negative indexes into their corresponding positive indexes and then checks to make sure the index is in the range [1..size]. The mapping between indexes is as follows:
```
 Negative Indexes:   -N      -N + 1     -N + 2     -N + 3   ...   -1
 Positive Indexes:    1         2          3          4     ...    N
 
```
    Parameters:
    
    index - The index to be normalized.
    
    Returns:
    
    The normalized [1..N] index.

Class Collection<E>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface craterdog.collections.interfaces.Accessible

Methods inherited from interface craterdog.collections.interfaces.Iteratable

Methods inherited from interface craterdog.core.Sequential

Methods inherited from interface java.lang.Iterable

Constructor Detail

Collection

Method Detail

toString

toString

equals

hashCode

isEmpty

toArray

containsAnyElementsIn

containsAllElementsIn

addElements

addElements

removeElements

removeElements

iterator

normalizedIndex