gov.usda.gdpc
Class AbstractGroup

java.lang.Object
  gov.usda.gdpc.AbstractGroup

All Implemented Interfaces:

java.util.Collection, Group, java.util.List

Direct Known Subclasses:

AbstractDBElementGroup

public abstract class AbstractGroup

extends java.lang.Object

implements Group

This class provides a skeletal implementation of the Group interface to minimize the effort required to implement this interface.

Author:

terryc

Constructor Summary

AbstractGroup()
AbstractGroup constructor.

AbstractGroup(Group[] groups)
AbstractGroup constructor.

AbstractGroup(Group[] groups, boolean sorted)
AbstractGroup constructor.

AbstractGroup(java.util.List list)
AbstractGroup constructor.

AbstractGroup(java.util.List list, boolean sorted)
AbstractGroup constructor.

AbstractGroup(java.lang.Object[] list)
AbstractGroup constructor.

AbstractGroup(java.lang.Object[] list, boolean sorted)
AbstractGroup constructor.

Method Summary

void	add(int index, java.lang.Object element) This operation is not supported.
boolean	add(java.lang.Object o) This operation is not supported.
boolean	addAll(java.util.Collection c) This operation is not supported.
boolean	addAll(int index, java.util.Collection c) This operation is not supported.
void	clear() This operation is not supported.
boolean	contains(java.lang.Object o) Returns true if this collection contains the specified element.
boolean	containsAll(java.util.Collection c) Returns true if this collection contains all of the elements in the specified collection.
java.lang.Object	get(int index) Returns the element at the specified position in this list.
int	indexOf(java.lang.Object o) Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element.
boolean	isEmpty() Returns true if this collection contains no elements.
java.util.Iterator	iterator() Returns an iterator over the elements in this collection.
int	lastIndexOf(java.lang.Object o) Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element.
java.util.ListIterator	listIterator() This operation is not supported.
java.util.ListIterator	listIterator(int index) This operation is not supported.
java.lang.Object	remove(int index) This operation is not supported.
boolean	remove(java.lang.Object o) This operation is not supported.
boolean	removeAll(java.util.Collection c) This operation is not supported.
boolean	retainAll(java.util.Collection c) This operation is not supported.
java.lang.Object	set(int index, java.lang.Object element) This operation is not supported.
int	size() Returns the number of elements in this collection.
java.util.List	subList(int fromIndex, int toIndex) Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
java.lang.Object[]	toArray() Returns an array containing all of the elements in this collection.
java.lang.Object[]	toArray(java.lang.Object[] a) Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
java.lang.String	toString() Returns string representation of this group.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode

Constructor Detail

AbstractGroup

public AbstractGroup(java.lang.Object[] list)

AbstractGroup constructor.

Parameters:

list - list of objects to be a part of this group. Any null in the list will be discarded.

AbstractGroup

public AbstractGroup(java.lang.Object[] list,
                     boolean sorted)

AbstractGroup constructor.

Parameters:

list - list of objects to be a part of this group. Any null in the list will be discarded.

sorted - true if group should be sorted.

AbstractGroup

public AbstractGroup()

AbstractGroup constructor. Creates an empty group.

AbstractGroup

public AbstractGroup(java.util.List list)

AbstractGroup constructor.

Parameters:

list - list of objects to be a part of this group. Any null in the list will be discarded.

AbstractGroup

public AbstractGroup(java.util.List list,
                     boolean sorted)

AbstractGroup constructor.

Parameters:

list - list of objects to be a part of this group. Any null in the list will be discarded.

sorted - true if group should be sorted.

AbstractGroup

public AbstractGroup(Group[] groups)

AbstractGroup constructor.

Parameters:

groups - groups to include in this new group.

AbstractGroup

public AbstractGroup(Group[] groups,
                     boolean sorted)

AbstractGroup constructor.

Parameters:

groups - groups to include in this new group.

sorted - true if group should be sorted.

Method Detail

add

public boolean add(java.lang.Object o)

This operation is not supported.

Specified by:

add in interface java.util.List

Throws:

java.lang.UnsupportedOperationException - this operation is not supported.

add

public void add(int index,
                java.lang.Object element)

This operation is not supported.

Specified by:

add in interface java.util.List

Throws:

java.lang.UnsupportedOperationException - this operation is not supported.

addAll

public boolean addAll(java.util.Collection c)

This operation is not supported.

Specified by:

addAll in interface java.util.List

Throws:

java.lang.UnsupportedOperationException - this operation is not supported.

addAll

public boolean addAll(int index,
                      java.util.Collection c)

This operation is not supported.

Specified by:

addAll in interface java.util.List

Throws:

java.lang.UnsupportedOperationException - this operation is not supported.

clear

public void clear()

This operation is not supported.

Specified by:

clear in interface java.util.List

Throws:

java.lang.UnsupportedOperationException - this operation is not supported.

contains

public boolean contains(java.lang.Object o)

Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).

Specified by:

contains in interface java.util.List

Parameters:

o - element whose presence in this collection is to be tested.

Returns:

true if this collection contains the specified element

Throws:

java.lang.ClassCastException - if the type of the specified element is incompatible with this collection (optional).

java.lang.NullPointerException - if the specified element is null and this collection does not support null elements (optional).

containsAll

public boolean containsAll(java.util.Collection c)

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

Specified by:

containsAll in interface java.util.List

Parameters:

c - collection to be checked for containment in this collection.

Returns:

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

Throws:

java.lang.ClassCastException - if the types of one or more elements in the specified collection are incompatible with this collection (optional).

java.lang.NullPointerException - if the specified collection contains one or more null elements and this collection does not support null elements (optional).

java.lang.NullPointerException - if the specified collection is null.

See Also:

contains(Object)

get

public java.lang.Object get(int index)

Returns the element at the specified position in this list.

Specified by:

get in interface java.util.List

Parameters:

index - index of element to return.

Returns:

the element at the specified position in this list.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

indexOf

public int indexOf(java.lang.Object o)

Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Specified by:

indexOf in interface java.util.List

Parameters:

o - element to search for.

Returns:

the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element.

Throws:

java.lang.ClassCastException - if the type of the specified element is incompatible with this list (optional).

java.lang.NullPointerException - if the specified element is null and this list does not support null elements (optional).

isEmpty

public boolean isEmpty()

Returns true if this collection contains no elements.

Specified by:

isEmpty in interface java.util.List

Returns:

true if this collection contains no elements

iterator

public java.util.Iterator iterator()

Returns an iterator over the elements in this collection. There are no guarantees concerning the order in which the elements are returned (unless this collection is an instance of some class that provides a guarantee).

Specified by:

iterator in interface java.util.List

Returns:

an Iterator over the elements in this collection

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Specified by:

lastIndexOf in interface java.util.List

Parameters:

o - element to search for.

Returns:

the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element.

Throws:

java.lang.ClassCastException - if the type of the specified element is incompatible with this list (optional).

java.lang.NullPointerException - if the specified element is null and this list does not support null elements (optional).

listIterator

public java.util.ListIterator listIterator()

This operation is not supported.

Specified by:

listIterator in interface java.util.List

Throws:

java.lang.UnsupportedOperationException - this operation is not supported.

listIterator

public java.util.ListIterator listIterator(int index)

This operation is not supported.

Specified by:

listIterator in interface java.util.List

Throws:

java.lang.UnsupportedOperationException - this operation is not supported.

remove

public java.lang.Object remove(int index)

This operation is not supported.

Specified by:

remove in interface java.util.List

Throws:

java.lang.UnsupportedOperationException - this operation is not supported.

remove

public boolean remove(java.lang.Object o)

This operation is not supported.

Specified by:

remove in interface java.util.List

Throws:

java.lang.UnsupportedOperationException - this operation is not supported.

removeAll

public boolean removeAll(java.util.Collection c)

This operation is not supported.

Specified by:

removeAll in interface java.util.List

Throws:

java.lang.UnsupportedOperationException - this operation is not supported.

retainAll

public boolean retainAll(java.util.Collection c)

This operation is not supported.

Specified by:

retainAll in interface java.util.List

Throws:

java.lang.UnsupportedOperationException - this operation is not supported.

set

public java.lang.Object set(int index,
                            java.lang.Object element)

This operation is not supported.

Specified by:

set in interface java.util.List

Throws:

java.lang.UnsupportedOperationException - this operation is not supported.

size

public int size()

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface java.util.List

Returns:

the number of elements in this collection

subList

public java.util.List subList(int fromIndex,
                              int toIndex)

Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list.

This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list:

 	    list.subList(from, to).clear();
 

Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class can be applied to a subList.

The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)

Specified by:

subList in interface java.util.List

Parameters:

fromIndex - low endpoint (inclusive) of the subList.

toIndex - high endpoint (exclusive) of the subList.

Returns:

a view of the specified range within this list.

Throws:

java.lang.IndexOutOfBoundsException - for an illegal endpoint index value (fromIndex < 0 || toIndex > size || fromIndex > toIndex).

toArray

public java.lang.Object[] toArray()

Returns an array containing all of the elements in this collection. If the collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Specified by:

toArray in interface java.util.List

Returns:

an array containing all of the elements in this collection

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)

Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this collection.

If this collection fits in the specified array with room to spare (i.e., the array has more elements than this collection), the element in the array immediately following the end of the collection is set to null. This is useful in determining the length of this collection only if the caller knows that this collection does not contain any null elements.)

If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the toArray method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs

Suppose l is a List known to contain only strings. The following code can be used to dump the list into a newly allocated array of String:

     String[] x = (String[]) v.toArray(new String[0]);
 

Note that toArray(new Object[0]) is identical in function to toArray().

Specified by:

toArray in interface java.util.List

Parameters:

a - the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

an array containing the elements of this collection

Throws:

java.lang.ArrayStoreException - the runtime type of the specified array is not a supertype of the runtime type of every element in this collection.

java.lang.NullPointerException - if the specified array is null.

toString

public java.lang.String toString()

Returns string representation of this group.

Returns:

string representation