structure5
Class StructCollection<E>

java.lang.Object
  structure5.StructCollection<E>

All Implemented Interfaces:

Iterable<E>, Collection<E>

public class StructCollection<E>
extends Object
implements Collection<E>

This utility class converts a Structure to a Collection. Users are advised to make use of the values method that is part of every Structure that returns a Collection.

This class is necessary because there are certain basic differences in the interfaces of the two classes.

This class works provides a facade: methods of the Collection interface are directly referred to the base Structure, or simple code supports the interface.

Example Usage:

 public static void main(String[] argv){
        Structure struct = new Vector();
        for(int i = 0; i < argv.length; i++) struct.add(argv[i]);
        Collection collect = new StructCollection(struct);
 } 
 

Since:

Java Structures, 2nd edition

Constructor Summary

StructCollection(Structure<E> s)
Constructs a Collection, based on the contents of the subordinate Structure object.

Method Summary

boolean	add(E o) Add an object to the subordinate Structure, and return boolean indicating success.
boolean	addAll(Collection<? extends E> c) Adds all the elements of another collection (c) into this Structure.
void	clear() Remove all elements from the Structure.
boolean	contains(Object o) Returns true iff object o is contained within the subordinate structure.
boolean	containsAll(Collection<?> c) Returns true if all of the elements of c are contained within the subordinate structure.
boolean	equals(Object o) Compare one StructCollection with another.
int	hashCode() Return hash code.
boolean	isEmpty() Detect an empty structure.
Iterator<E>	iterator() Return an iterator to traverse the subordinate structure.
boolean	remove(Object o) Removes an instance of object o, if it appears within structure.
boolean	removeAll(Collection<?> c) Removes all objects found within collection c from this collection.
boolean	retainAll(Collection<?> c) Retains elements of this Collection that are also in c.
int	size() Determine the number of elements in this collection.
Object[]	toArray() Construct an array of values found in the subordinate Structure.
<T> T[]	toArray(T[] target) Copy elements of this structure into target array.
String	toString() Construct a string representation of this class.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StructCollection

public StructCollection(Structure<E> s)

Constructs a Collection, based on the contents of the subordinate Structure object.

Method Detail

add

public boolean add(E o)

Add an object to the subordinate Structure, and return boolean indicating success.

Specified by:

add in interface Collection<E>

Returns:

true.

addAll

public boolean addAll(Collection<? extends E> c)

Adds all the elements of another collection (c) into this Structure. A boolean value of true is returned.

Specified by:

addAll in interface Collection<E>

Returns:

true if each of the adds returned true.

clear

public void clear()

Remove all elements from the Structure.

Specified by:

clear in interface Collection<E>

contains

public boolean contains(Object o)

Returns true iff object o is contained within the subordinate structure.

Specified by:

contains in interface Collection<E>

containsAll

public boolean containsAll(Collection<?> c)

Returns true if all of the elements of c are contained within the subordinate structure.

Specified by:

containsAll in interface Collection<E>

Returns:

true if c is a subset of this

equals

public boolean equals(Object o)

Compare one StructCollection with another.

Specified by:

equals in interface Collection<E>

Overrides:

equals in class Object

Returns:

true iff Structures are equals

hashCode

public int hashCode()

Return hash code.

Specified by:

hashCode in interface Collection<E>

Overrides:

hashCode in class Object

Returns:

hash code of subordinate structure.

isEmpty

public boolean isEmpty()

Detect an empty structure.

Specified by:

isEmpty in interface Collection<E>

Returns:

true iff subordinate structure is empty.

iterator

public Iterator<E> iterator()

Return an iterator to traverse the subordinate structure.

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Returns:

the iterator over the subordinate structure.

remove

public boolean remove(Object o)

Removes an instance of object o, if it appears within structure.

Specified by:

remove in interface Collection<E>

Returns:

returns true if instance was found and removed.

removeAll

public boolean removeAll(Collection<?> c)

Removes all objects found within collection c from this collection.

Specified by:

removeAll in interface Collection<E>

Returns:

true if every element of c could be removed from this.

retainAll

public boolean retainAll(Collection<?> c)

Retains elements of this Collection that are also in c.

Specified by:

retainAll in interface Collection<E>

Returns:

true iff this Collection was changed by this operation

size

public int size()

Determine the number of elements in this collection.

Specified by:

size in interface Collection<E>

Returns:

the number of elements in this collection.

toArray

public Object[] toArray()

Construct an array of values found in the subordinate Structure.

Specified by:

toArray in interface Collection<E>

Returns:

array containing exactly the elements of this structure

toArray

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

Copy elements of this structure into target array.

Specified by:

toArray in interface Collection<E>

Returns:

the array of values

toString

public String toString()

Construct a string representation of this class.

Overrides:

toString in class Object

Returns:

string representing this class