br.com.objectos.core.collection

Interface MutableCollection<E>

Type Parameters:

E - type of the elements in this collection

All Superinterfaces:

BaseCollection<E>, Collection<E>, Iterable<E>, Joinable, br.com.objectos.core.object.ToStringObject

public interface MutableCollection<E>
extends BaseCollection<E>

A mutable BaseCollection.

This interface extends the BaseCollection interface by providing additional methods for adding elements to the collection.

See Also:

BaseCollection

Method Summary

Modifier and Type	Method and Description
boolean	addAllIterable(Iterable<? extends E> elements) Adds all elements of the given Iterable to this collection.
boolean	addWithNullMessage(E e, Object nullMessage) Adds the specified element e to this collection or throws a NullPointerException if the element is null.
boolean	addWithNullMessage(E e, Object nullMessageStart, int index, Object nullMessageEnd) Adds the specified element e to this collection or throws a NullPointerException if the element is null.

Methods inherited from interface br.com.objectos.core.collection.BaseCollection

add, addAll, contains, getOnly, iterator, remove, removeAll, removeIf, retainAll

Methods inherited from interface java.util.Collection

clear, contains, containsAll, equals, hashCode, isEmpty, parallelStream, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface br.com.objectos.core.collection.Joinable

join, join, join

Methods inherited from interface br.com.objectos.core.object.ToStringObject

formatToString

Method Detail

addAllIterable

boolean addAllIterable(Iterable<? extends E> elements)

Adds all elements of the given Iterable to this collection.

Elements are added in the order they are returned by the given iterable's iterator. If the iterator returns a null element then this method does not return and throws a NullPointerException instead.

Parameters:

elements - the elements to be added to this collection

Returns:

true if this collection changed as a result of this operation

addWithNullMessage

boolean addWithNullMessage(E e,
                           Object nullMessage)

Adds the specified element e to this collection or throws a NullPointerException if the element is null.

If a NullPointerException is to be thrown, the nullMessage value is used as the exception's message.

Typical usage:

 coll.addWithNullMessage(value, "value == null");

Parameters:

e - an element to be added to this collection

nullMessage - the NullPointerException message

Returns:

true if this collection changed as a result of this operation

addWithNullMessage

boolean addWithNullMessage(E e,
                           Object nullMessageStart,
                           int index,
                           Object nullMessageEnd)

Adds the specified element e to this collection or throws a NullPointerException if the element is null.

If a NullPointerException is to be thrown, the concatenation of nullMessageStart, index and nullMessageEnd is used as the exception's message.

Typical usage:

 coll.addWithNullMessage(element, "elements[", index, "] == null");

Parameters:

e - an element to be added to this collection

nullMessageStart - the first part of the NullPointerException message

index - the second part of the NullPointerException message

nullMessageEnd - the third part of the NullPointerException message

Returns:

true if this collection changed as a result of this operation