net.sf.eBus.messages

Class EFieldList<E extends EField>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<E>

net.sf.eBus.messages.EAbstractList<E>

net.sf.eBus.messages.EFieldList<E>

Type Parameters:

E - specifies the homogenous, concrete EField type stored in this list.

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Collection<E>, List<E>, RandomAccess

public final class EFieldList<E extends EField>
extends EAbstractList<E>
implements Serializable, Cloneable

An ArrayList specifically containing EField elements. The difference between this class and EField[] is that this list contains homogenous field elements: all the fields must belong to the same concrete class (that is, a non-abstract class). Homogeneity decreases the serialized buffer size and decreases the serialization/de-serialization processing time. The reason is that the listed EField class is serialized once and its data type is used for all field elements. Contrast this EField[] which allows heterogenous elements. Each field class must be serialized and its associated data type used to serialize the element. This greatly increases the serialized buffer size and processing time.

In short, when transmitting a homogenous EField list, EFieldList is to be preferred over EField[].

This class extends ArrayList, providing all the features available in that class.

There is no limit as to the number of elements which may be placed into this list. But care must be taken not to overflow the eBus ByteBuffer when serializing for transport.

Java allows EFieldList to be instantiated without using the generic parameter. That allows non-EField objects to be placed into the list. Another problem is using an abstract EField class as the generic parameter. EFieldList does not protect against these uses, resulting in undefined and unwanted behavior. EFieldList should be declared with a concrete EField subclass.

Author:

Charles W. Rapp

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sf.eBus.messages.EAbstractList

mReadOnlyFlag

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
EFieldList() Creates an empty field list instance with an initial capacity of ten.
EFieldList(Collection<E> c) Creates a field list instance containing the same elements as c and in the order returned by the collection's iterator.
EFieldList(int initialCapacity) Creates an empty field list instance with the specified initial capacity.

Method Summary

Modifier and Type	Method and Description
Class<E>	elementClass() Returns the stored element class.

Methods inherited from class net.sf.eBus.messages.EAbstractList

add, add, addAll, addAll, clear, isReadOnly, iterator, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, setReadOnly, sort, subList

Methods inherited from class java.util.ArrayList

clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, lastIndexOf, size, spliterator, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

EFieldList

public EFieldList()

Creates an empty field list instance with an initial capacity of ten.

EFieldList

public EFieldList(int initialCapacity)

Creates an empty field list instance with the specified initial capacity.

Parameters:

initialCapacity - initial list capacity.

EFieldList

public EFieldList(Collection<E> c)

Creates a field list instance containing the same elements as c and in the order returned by the collection's iterator.

Parameters:

c - place this collection's element into this field list.

Throws:

NullPointerException - if c is null.

Method Detail

elementClass

public Class<E> elementClass()

Returns the stored element class. Returns null if the list is empty.

Returns:

stored element class.