br.com.objectos.core.collection

Interface BaseCollection<E>

Type Parameters:

E - type of the elements in this collection

All Superinterfaces:

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

All Known Subinterfaces:

ImmutableCollection<E>, MutableCollection<E>

All Known Implementing Classes:

AbstractBaseCollection

@Generated(value="br.com.objectos.latest.processor.TemplateProcessor")
public interface BaseCollection<E>
extends Collection<E>, Joinable, br.com.objectos.core.object.ToStringObject

The base Collection interface for the Objectos Collections API.

Implementations of this interface are required to reject null elements.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(E e) Adds the specified element to this collection.
boolean	addAll(Collection<? extends E> c) Adds all of the elements of the specified collection to this collection.
boolean	contains(Object first, Object... more) Returns true if this collection contains all the given values.
E	getOnly() Returns the only element of this collection or throws an exception if the collection is empty or if the collection contains more than one element.
UnmodifiableIterator<E>	iterator() Returns an unmodifiable iterator over the elements in this collection.
boolean	remove(Object o) This operation is not supported.
boolean	removeAll(Collection<?> c) This operation is not supported.
boolean	retainAll(Collection<?> c) This operation is not supported.

Methods inherited from interface java.util.Collection

clear, contains, containsAll, equals, hashCode, isEmpty, size, toArray, toArray

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

add

boolean add(E e)

Adds the specified element to this collection.

Specified by:

add in interface Collection<E>

Parameters:

e - an element to be added to this collection

Returns:

true if this collection was modified as a result of this operation

Throws:

NullPointerException - if the specified element is null

addAll

boolean addAll(Collection<? extends E> c)

Adds all of the elements of the specified collection to this collection.

Specified by:

addAll in interface Collection<E>

Parameters:

c - a collection containing the elements to be added to this collection

Returns:

true if this collection was modified as a result of this operation

Throws:

NullPointerException - if the specified collection is null or if any of its element is null

contains

boolean contains(Object first,
               Object... more)

Returns true if this collection contains all the given values. More formally, and using the contains definition given by Collection.contains(Object), returns true if and only if this collection contains the first specified element or if contains any element of rest array.

This method does not throw a ClassCastException if any of the supplied values if of a type that is incompatible with this collection.

Parameters:

first - the first element to check for presence in the collection

more - the additional elements to check for presence in the collection

Returns:

true if this collection contains any of the given values

getOnly

E getOnly()
          throws IllegalStateException

Returns the only element of this collection or throws an exception if the collection is empty or if the collection contains more than one element.

Returns:

the only element of this collection

Throws:

IllegalStateException - if the collection is empty or if the collection contains more than one element

iterator

UnmodifiableIterator<E> iterator()

Returns an unmodifiable iterator over the elements in this collection.

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Returns:

an unmodifiable iterator over the elements in this collection

remove

boolean remove(Object o)

This operation is not supported.

This method performs no operation other than throw an UnsupportedOperationException.

Specified by:

remove in interface Collection<E>

Parameters:

o - ignored (this operation is not supported)

Returns:

this method does not return as it always throw an exception

Throws:

UnsupportedOperationException - always

removeAll

boolean removeAll(Collection<?> c)

This operation is not supported.

This method performs no operation other than throw an UnsupportedOperationException.

Specified by:

removeAll in interface Collection<E>

Parameters:

c - ignored (this operation is not supported)

Returns:

this method does not return as it always throw an exception

Throws:

UnsupportedOperationException - always

retainAll

boolean retainAll(Collection<?> c)

This operation is not supported.

This method performs no operation other than throw an UnsupportedOperationException.

Specified by:

retainAll in interface Collection<E>

Parameters:

c - ignored (this operation is not supported)

Returns:

this method does not return as it always throw an exception

Throws:

UnsupportedOperationException - always