Elements (org.refcodes:refcodes-struct 2.2.2 API)

Type Parameters:

E - The type of the elements being stored in the Elements.MutableElements.

All Known Subinterfaces:

Container<E>, Container.ClearableContainer<E>, Container.MutableContainer<E>, Elements.ClearableElements<E>, Elements.MutableElements<E>
```
public interface Elements<E>
```
Basic functionality being provided by any Elements (collection) style class.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`Elements.ClearableElements<E>`	Extends the `Elements` interface with `Clearable` functionality (as of `Clearable.clear()`).
`static interface`	`Elements.MutableElements<E>`	Extends the `Elements` with mutable (writable) functionality, especially by enabling the `Iterator.remove()` method in the `Iterator` provided via `Elements.MutableElements.iterator()` and by providing the `Elements.MutableElements.add(Object)` and the `Elements.MutableElements.remove(Object)` methods.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`contains(Object aElement)`	Tests whether the specified object is an element of the `Elements` (collection).
`Iterator<E>`	`iterator()`	Returns an `Iterator` instance of all the data elements contained in the `Elements` (collection). ------------------------------------------------------------------------- ATTENTION: The `Iterator.remove()` method may be disabled in the returned `Iterator` instance as the `Elements` is supposed to be read-only.

- Method Detail
  - iterator
```
Iterator<E> iterator()
```
    Returns an Iterator instance of all the data elements contained in the Elements (collection). ------------------------------------------------------------------------- ATTENTION: The Iterator.remove() method may be disabled in the returned Iterator instance as the Elements is supposed to be read-only.
    
    Returns:
    
    A (read-only) Iterator providing the elements of the Elements.
  - contains
```
boolean contains(Object aElement)
```
    Tests whether the specified object is an element of the Elements (collection). Returns true if this Elements contains the specified element. More formally, returns true if and only if this Elements contains an element e such that (obj==null ? e==null : obj.equals(e))
    
    Parameters:
    
    aElement - The object to be tested whether it is contained in this Elements or not.
    
    Returns:
    
    Description True in case the given object is contained in this Elements.