Module org.refcodes.struct

Package org.refcodes.struct

Interface Elements.MutableElements<E>

Type Parameters:

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

All Superinterfaces:

org.refcodes.mixin.Clearable, Elements<E>, Elements.ClearableElements<E>

All Known Subinterfaces:

Container.MutableContainer<E>

Enclosing interface:

Elements<E>

public static interface Elements.MutableElements<E>
extends Elements.ClearableElements<E>

Extends the Elements with mutable (writable) functionality, especially by enabling the Iterator.remove() method in the Iterator provided via iterator() and by providing the add(Object) and the remove(Object) methods.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.struct.Elements

Elements.ClearableElements<E>, Elements.MutableElements<E>

Method Summary

Modifier and Type	Method	Description
boolean	add(E aElement)	Same as Collection.add(Object).
Iterator<E>	iterator()	Returns an Iterator instance of all the data elements contained in the container (collection). --------------------------------------------------------------------- ATTENTION: The Iterator.remove() method is enabled in the returned Iterator instance as the Elements.MutableElements is possibly readable and writable.
boolean	remove(Object aElement)	Same as Collection.remove(Object).

Methods inherited from interface org.refcodes.mixin.Clearable

clear

Methods inherited from interface org.refcodes.struct.Elements

contains

Method Detail

add

boolean add(E aElement)

Same as Collection.add(Object).

Parameters:

aElement - the element whose presence in this collection is to be ensured

Returns:

True if this collection changed as a result of the call

See Also:

Collection.add(Object)

remove

boolean remove(Object aElement)

Same as Collection.remove(Object).

Parameters:

aElement - The element to be removed from this collection, if present

Returns:

True if an element was removed as a result of this call.

See Also:

Collection.remove(Object)

iterator

Iterator<E> iterator()

Returns an Iterator instance of all the data elements contained in the container (collection). --------------------------------------------------------------------- ATTENTION: The Iterator.remove() method is enabled in the returned Iterator instance as the Elements.MutableElements is possibly readable and writable.

Specified by:

iterator in interface Elements<E>

Returns:

A (writable) Iterator providing the elements of the Elements (possibly with the Iterator.remove() method being enabled).