br.com.objectos.core.collection

Class AbstractBaseCollection<E>

java.lang.Object

br.com.objectos.core.collection.AbstractBaseCollection<E>

Type Parameters:

E - type of the elements in this collection

All Implemented Interfaces:

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

@Generated(value="br.com.objectos.latest.processor.ConcreteClassProcessor")
public abstract class AbstractBaseCollection<E>
extends Object

An array-based abstract implementation of BaseCollection.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBaseCollection() Sole constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(Object first, Object... more) Returns true if this collection contains all of the specified elements.
boolean	containsAll(Collection<?> c) Returns true if this collection contains all of the elements in the specified collection.
void	formatToString(StringBuilder toString, int level) Formats and appends to the toString builder at the specified indentation level a string representation of this collection.
E	getOnly() Returns the only element in this collection or throws an exception if the collection is empty or if the collection contains more than one element.
protected E	getOnlyImpl() This method is called by getOnly() when the size is size == 1.
protected String	indexName(int index, int length) Returns a name for the specified index having the specified length, result is padded with zero digits if necessary.
boolean	isEmpty() Returns true if this collection contains no elements.
String	join() Returns a new string by joining together, in iteration order, the string representation of each element in this collection.
String	join(String delimiter) Returns a new string by joining together, in iteration order, the string representation of each element in this collection separated by the specified delimiter.
String	join(String delimiter, String prefix, String suffix) Returns a new string by joining together, in iteration order, the string representation of each element in this collection separated by the specified delimiter and with the specified prefix and suffix.
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.
protected int	sizeDigits() Returns the number of digits this collection's size has.
Object[]	toArray() Not implemented in this release.
<T> T[]	toArray(T[] a) Not implemented in this release.
String	toString() Returns the string representation of this collection as defined by the ToStringObject.formatToString(StringBuilder, int) method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

add, addAll, iterator

Methods inherited from interface java.util.Collection

clear, contains, equals, hashCode, size

Constructor Detail

AbstractBaseCollection

protected AbstractBaseCollection()

Sole constructor

Method Detail

contains

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

Returns true if this collection contains all of the specified elements.

Specified by:

contains in interface BaseCollection<E>

Parameters:

first - the first element to check for presence in this set

more - the additional elements to check for presence in this set

Returns:

true if this collection contains all of the specified elements

See Also:

Collection.contains(Object)

containsAll

public final boolean containsAll(Collection<?> c)

Returns true if this collection contains all of the elements in the specified collection.

This method does not throw a ClassCastException.

Specified by:

containsAll in interface Collection<E>

Parameters:

c - a collection whose elements are to be checked

Returns:

true if this collection contains all of the elements in the specified collection

See Also:

Collection.contains(Object)

formatToString

public void formatToString(StringBuilder toString,
                  int level)

Formats and appends to the toString builder at the specified indentation level a string representation of this collection.

The string representation may contain:

• the simple name of the collections's class; and
• the string representation of each element paired with its iteration index

Specified by:

formatToString in interface br.com.objectos.core.object.ToStringObject

Parameters:

toString - the builder of a toString method

level - the indentation level.

getOnly

public final E getOnly()

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

Specified by:

getOnly in interface BaseCollection<E>

Returns:

the only element of this collection

Throws:

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

isEmpty

public final boolean isEmpty()

Returns true if this collection contains no elements.

Specified by:

isEmpty in interface Collection<E>

Returns:

true if this collection contains no elements

join

public String join()

Returns a new string by joining together, in iteration order, the string representation of each element in this collection.

The string representation of each element is obtained by invoking its Object.toString() method.

Specified by:

join in interface Joinable

Returns:

a new string representing this collection

join

public String join(String delimiter)

Returns a new string by joining together, in iteration order, the string representation of each element in this collection separated by the specified delimiter.

The string representation of each element is obtained by invoking its Object.toString() method.

Specified by:

join in interface Joinable

Parameters:

delimiter - the separator to use

Returns:

a new string representing this collection

join

public String join(String delimiter,
          String prefix,
          String suffix)

Returns a new string by joining together, in iteration order, the string representation of each element in this collection separated by the specified delimiter and with the specified prefix and suffix.

Specified by:

join in interface Joinable

Parameters:

delimiter - the separator to use

prefix - the first part of the output

suffix - the last part of the output

Returns:

a new string representing this collection

remove

public final boolean remove(Object o)

This operation is not supported.

This method performs no operation other than throw an UnsupportedOperationException.

Specified by:

remove in interface BaseCollection<E>

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

public final boolean removeAll(Collection<?> c)

This operation is not supported.

This method performs no operation other than throw an UnsupportedOperationException.

Specified by:

removeAll in interface BaseCollection<E>

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

public final boolean retainAll(Collection<?> c)

This operation is not supported.

This method performs no operation other than throw an UnsupportedOperationException.

Specified by:

retainAll in interface BaseCollection<E>

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

toArray

public Object[] toArray()

Not implemented in this release. It might be implemented in a future release.

Specified by:

toArray in interface Collection<E>

Returns:

this method does not return as it always throws an exception

Throws:

UnsupportedOperationException - this method may be implemented in a future release

toArray

public <T> T[] toArray(T[] a)

Not implemented in this release. It might be implemented in a future release.

Specified by:

toArray in interface Collection<E>

Parameters:

a - ignored (this operation in not yet implemented)

Returns:

this method does not return as it always throws an exception

Throws:

UnsupportedOperationException - this method may be implemented in a future release

toString

public final String toString()

Returns the string representation of this collection as defined by the ToStringObject.formatToString(StringBuilder, int) method.

Overrides:

toString in class Object

Returns:

a string representation of this collection

getOnlyImpl

protected E getOnlyImpl()

This method is called by getOnly() when the size is size == 1.

Returns:

the only element in this collection

indexName

protected final String indexName(int index,
               int length)

Returns a name for the specified index having the specified length, result is padded with zero digits if necessary.

Auxiliary method for formatToString(StringBuilder, int) implementation.

Examples:

indexName(1, 3); // returns "001"
 indexName(37, 3); // returns "037"
 indexName(912, 3); // returns "912"
 

Parameters:

index - the index value to format

length - the length of the result string

Returns:

a name for the specified index having the specified length

sizeDigits

protected final int sizeDigits()

Returns the number of digits this collection's size has.

Auxiliary method for formatToString(StringBuilder, int) implementation.

Returns:

the number of digits this collection's size has