org.opt4j.core
Class IndividualSet

java.lang.Object
  extended by org.opt4j.core.IndividualSet
All Implemented Interfaces:
java.lang.Iterable<Individual>, java.util.Collection<Individual>, java.util.Set<Individual>
Direct Known Subclasses:
Archive, Population

public class IndividualSet
extends java.lang.Object
implements java.util.Set<Individual>

The IndividualSet is a Set of Individuals. It allows to add and remove listeners, see IndividualSetListener.

See Also:
Archive, Population

Field Summary
protected  java.util.Set<Individual> individuals
           
protected  java.util.Set<IndividualSetListener> listeners
           
 
Constructor Summary
IndividualSet()
           
 
Method Summary
 boolean add(Individual individual)
           
 boolean addAll(java.util.Collection<? extends Individual> c)
           
 boolean addAll(Individual... c)
          Add all Individuals.
 void addListener(IndividualSetListener listener)
          Adds a listener.
 void clear()
           
 boolean contains(java.lang.Object o)
           
 boolean containsAll(java.util.Collection<?> c)
           
 boolean isEmpty()
           
 java.util.Iterator<Individual> iterator()
           
 boolean remove(java.lang.Object o)
           
 boolean removeAll(java.util.Collection<?> c)
           
 void removeListener(IndividualSetListener listener)
          Removes a listener.
 boolean retainAll(java.util.Collection<?> c)
           
 int size()
           
 java.lang.Object[] toArray()
           
<T> T[]
toArray(T[] a)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Set
equals, hashCode
 

Field Detail

individuals

protected final java.util.Set<Individual> individuals

listeners

protected final java.util.Set<IndividualSetListener> listeners
Constructor Detail

IndividualSet

public IndividualSet()
Method Detail

add

public boolean add(Individual individual)
Specified by:
add in interface java.util.Collection<Individual>
Specified by:
add in interface java.util.Set<Individual>

iterator

public java.util.Iterator<Individual> iterator()
Specified by:
iterator in interface java.lang.Iterable<Individual>
Specified by:
iterator in interface java.util.Collection<Individual>
Specified by:
iterator in interface java.util.Set<Individual>

size

public int size()
Specified by:
size in interface java.util.Collection<Individual>
Specified by:
size in interface java.util.Set<Individual>

addListener

public void addListener(IndividualSetListener listener)
Adds a listener.

Parameters:
listener - the added listener
See Also:
removeListener(org.opt4j.core.IndividualSetListener)

removeListener

public void removeListener(IndividualSetListener listener)
Removes a listener.

Parameters:
listener - the removed listener
See Also:
addListener(org.opt4j.core.IndividualSetListener)

clear

public void clear()
Specified by:
clear in interface java.util.Collection<Individual>
Specified by:
clear in interface java.util.Set<Individual>

addAll

public boolean addAll(java.util.Collection<? extends Individual> c)
Specified by:
addAll in interface java.util.Collection<Individual>
Specified by:
addAll in interface java.util.Set<Individual>

addAll

public boolean addAll(Individual... c)
Add all Individuals.

Parameters:
c - the individuals to be added
Returns:
true if at least one individual was added

contains

public boolean contains(java.lang.Object o)
Specified by:
contains in interface java.util.Collection<Individual>
Specified by:
contains in interface java.util.Set<Individual>

containsAll

public boolean containsAll(java.util.Collection<?> c)
Specified by:
containsAll in interface java.util.Collection<Individual>
Specified by:
containsAll in interface java.util.Set<Individual>

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Collection<Individual>
Specified by:
isEmpty in interface java.util.Set<Individual>

remove

public boolean remove(java.lang.Object o)
Specified by:
remove in interface java.util.Collection<Individual>
Specified by:
remove in interface java.util.Set<Individual>

removeAll

public boolean removeAll(java.util.Collection<?> c)
Specified by:
removeAll in interface java.util.Collection<Individual>
Specified by:
removeAll in interface java.util.Set<Individual>

retainAll

public boolean retainAll(java.util.Collection<?> c)
Specified by:
retainAll in interface java.util.Collection<Individual>
Specified by:
retainAll in interface java.util.Set<Individual>

toArray

public java.lang.Object[] toArray()
Specified by:
toArray in interface java.util.Collection<Individual>
Specified by:
toArray in interface java.util.Set<Individual>

toArray

public <T> T[] toArray(T[] a)
Specified by:
toArray in interface java.util.Collection<Individual>
Specified by:
toArray in interface java.util.Set<Individual>