WellSet (MicroFlex - Integer 1.0.0 API)

java.lang.Object
- com.github.jessemull.microflexinteger.plate.WellSet

All Implemented Interfaces:

Comparable<WellSet>, Iterable<Well>
```
public class WellSet
extends Object
implements Iterable<Well>, Comparable<WellSet>
```
This class represents a set of wells. The well set implements all the methods available in the Java set class. The well set cannot contain duplicate well values. Unlike the plate object, the well set object does not enforce plate dimensions or wells within a specified range. Like all members of the MicroFlex library, the well set is meant to be flexible and accepts collections and arrays of wells for constructors and methods. The well set object implements the Iterable interface. The iterator iterates over the wells in the set.

Author:

Jesse L. Mull

Constructor Summary

Constructors
Constructor and Description
`WellSet()` Creates a new Integer well set.
`WellSet(Collection<Well> collection)` Creates a new well set from a collection of wells.
`WellSet(Collection<Well> collection, String label)` Creates a new well set from a collection of wells and a label.
`WellSet(Well[] wells)` Creates a new well set from an array of wells.
`WellSet(Well[] wells, String label)` Creates a new well set from an array of wells and a label.
`WellSet(WellSet set)` Creates a new well set from another well set.
`WellSet(WellSet set, String label)` Creates a new well set from another well set and a label.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(Collection<Well> collection)` Adds a collection of wells to the well set.
`boolean`	`add(Well well)` Adds a well to the well set.
`boolean`	`add(Well[] array)` Adds an array of wells to the well set.
`boolean`	`add(WellSet set)` Adds the wells in the input well set.
`Set<Well>`	`allWells()` Returns the well set.
`Well`	`ceiling(Well well)` Returns the least well in this set greater than or equal to the given well, or null if there is no such well.
`void`	`clear()` Clears the set.
`int`	`compareTo(WellSet set)` Compares two well set objects.
`boolean`	`contains(Collection<Well> collection)` Returns true if all the input wells are found within the well set.
`boolean`	`contains(String well)` Returns true if the well is part of the well set.
`boolean`	`contains(String wellList, String delimiter)` Returns true if the wells are part of the set.
`boolean`	`contains(Well well)` Returns true if the well is part of the well set.
`boolean`	`contains(Well[] array)` Returns true if all the input wells are found within the well array.
`boolean`	`contains(WellIndex index)` Returns true if the well is part of the set.
`boolean`	`contains(WellList list)` Returns true if the wells exist in the set.
`boolean`	`contains(WellSet set)` Returns true if all the input wells are found within the well set.
`Iterator<Well>`	`descendingIterator()` Returns an iterator over the wells in this set in descending order.
`Set<Well>`	`descendingSet()` Returns a reverse order view of the wells contained in this set.
`boolean`	`equals(Object object)` Well sets are equivalent if they contain the same wells and label.
`Well`	`first()` Returns the first well in the set.
`Well`	`floor(Well well)` Returns the greatest well in this set less than or equal to the given well, or null if there is no such well.
`WellSet`	`getColumn(int column)` Returns all wells with the matching column index.
`WellSet`	`getRow(int row)` Returns all wells with the matching row index.
`WellSet`	`getWells(Collection<Well> collection)` Returns a well set holding all plate wells that match the indices or null if there are no matches.
`Well`	`getWells(String well)` Returns the well with the input indices.
`WellSet`	`getWells(String wellList, String delimiter)` Returns a well set holding all plate wells that match the indices or null if there are no matches.
`Well`	`getWells(Well input)` Returns the well or null if no such well exists.
`WellSet`	`getWells(Well[] array)` Returns a well set holding all wells that match the indices or null if there are no matches.
`Well`	`getWells(WellIndex index)` Returns the well or null if the well does not exist.
`WellSet`	`getWells(WellList list)` Returns a well set containing the wells in the list or null if none of the wells exist.
`WellSet`	`getWells(WellSet input)` Returns a well set holding all plate wells that match the indices or null if there are no matches.
`int`	`hashCode()` Hash code uses the wells and label.
`Set<Well>`	`headSet(int index)` Returns a view of the portion of this set whose wells are less than or equal to the index.
`Set<Well>`	`headSet(int index, boolean inclusive)` Returns a view of the portion of this set whose wells are less than (or equal to, if inclusive is true) the index.
`Set<Well>`	`headSet(Well well)` Returns a view of the portion of this set whose wells are strictly less than the input well.
`Set<Well>`	`headSet(Well well, boolean inclusive)` Returns a view of the portion of this set whose wells are less than (or equal to, if inclusive is true) to the input well.
`Well`	`higher(Well well)` Returns the least well in this set strictly greater than the given well, or null if there is no such well.
`boolean`	`isEmpty()` Returns true if this set contains no wells.
`Iterator<Well>`	`iterator()` Returns an iterator over the wells in this set in ascending order.
`String`	`label()` Returns the label.
`Well`	`last()` Returns the last well in the set.
`Well`	`lower(Well well)` Returns the greatest well in this set strictly less than the given well, or null if there is no such well.
`Well`	`pollFirst()` Retrieves and removes the first (lowest) well, or returns null if this set is empty.
`Well`	`pollLast()` Retrieves and removes the last (highest) well, or returns null if this set is empty.
`boolean`	`remove(Collection<Well> collection)` Removes a collection of wells from the well set.
`boolean`	`remove(String well)` Removes the well with the well index.
`boolean`	`remove(String wellList, String delimiter)` Removes a well or a list of delimiter separated wells.
`boolean`	`remove(Well well)` Removes a well from the well set.
`boolean`	`remove(Well[] array)` Removes an array of wells from the well set.
`boolean`	`remove(WellIndex index)` Removes the well with the well index.
`boolean`	`remove(WellList list)` Removes the wells in the list.
`boolean`	`remove(WellSet set)` Removes the wells in the input well set.
`boolean`	`replace(Collection<Well> collection)` Replaces the set wells with the wells from the collection.
`boolean`	`replace(Well well)` Replaces the set well with the input well.
`boolean`	`replace(Well[] array)` Replaces the set wells with the wells from the array.
`boolean`	`replace(WellSet set)` Replaces the set wells with the wells from the input set.
`boolean`	`retain(Collection<Well> collection)` Retains the wells in the collection if they exist.
`boolean`	`retain(String well)` Retains the well.
`boolean`	`retain(String wellList, String delimiter)` Retain the wells in the delimiter separated list.
`boolean`	`retain(Well well)` Retains the input well if it exists.
`boolean`	`retain(Well[] array)` Retains the wells in the array if they exist.
`boolean`	`retain(WellIndex index)` Retains the well with the well index.
`boolean`	`retain(WellList list)` Retains the wells in the list.
`boolean`	`retain(WellSet set)` Retains the wells in the well set if they exist.
`void`	`setLabel(String label)` Sets the set label.
`int`	`size()` Returns the size of the well set.
`Set<Well>`	`subSet(int index1, boolean inclusive1, int index2, boolean inclusive2)` Returns a view of the portion of this set between the indices.
`Set<Well>`	`subSet(int index1, int index2)` Returns a view of the portion of this set between the indices.
`Set<Well>`	`subSet(Well well1, boolean inclusive1, Well well2, boolean inclusive2)` Returns a view of the portion of this set whose wells range from the first input well to the second input well.
`Set<Well>`	`subSet(Well well1, Well well2)` Returns a view of the portion of this set whose wells range from the first input well inclusive to the second input well inclusive.
`Set<Well>`	`tailSet(int index)` Returns a view of the portion of this set whose wells are greater than or equal to the index.
`Set<Well>`	`tailSet(int index, boolean inclusive)` Returns a view of the portion of this set whose wells are greater than (or equal to, if inclusive is true) the index.
`Set<Well>`	`tailSet(Well well)` Returns a view of the portion of this set whose wells are greater than or equal to the input well.
`Set<Well>`	`tailSet(Well well, boolean inclusive)` Returns a view of the portion of this set whose wells are greater than (or equal to, if inclusive is true) the input well.
`String`	`toString()` Returns a string containing the label and wells.
`String[]`	`toStringArray()` Returns the well set as an array of well IDs.
`Well[]`	`toWellArray()` Returns the well set as an array of wells.
`WellList`	`wellList()` Returns all indices in the set in a well list.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - WellSet
```
public WellSet()
```
    Creates a new Integer well set.
  - WellSet
```
public WellSet(Collection<Well> collection)
```
    Creates a new well set from a collection of wells.
    
    Parameters:
    
    Collection - the collection of wells
  - WellSet
```
public WellSet(Collection<Well> collection,
               String label)
```
    Creates a new well set from a collection of wells and a label.
    
    Parameters:
    
    Collection - the collection of wells
    
    String - the label
  - WellSet
```
public WellSet(WellSet set)
```
    Creates a new well set from another well set.
    
    Parameters:
    
    WellSet - the well set
  - WellSet
```
public WellSet(WellSet set,
               String label)
```
    Creates a new well set from another well set and a label.
    
    Parameters:
    
    WellSet - the well set
    
    String - the label
  - WellSet
```
public WellSet(Well[] wells)
```
    Creates a new well set from an array of wells.
    
    Parameters:
    
    Well[] - the array of wells
  - WellSet
```
public WellSet(Well[] wells,
               String label)
```
    Creates a new well set from an array of wells and a label.
    
    Parameters:
    
    WellSet - well set
    
    String - label
- Method Detail
  - add
```
public boolean add(Well well)
```
    Adds a well to the well set.
    
    Parameters:
    
    int - the well
    
    Returns:
    
    true on successful well addition
  - add
```
public boolean add(WellSet set)
```
    Adds the wells in the input well set.
    
    Parameters:
    
    WellSet - the well set
    
    Returns:
    
    true on successful addition of all wells
  - add
```
public boolean add(Collection<Well> collection)
```
    Adds a collection of wells to the well set.
    
    Parameters:
    
    Collection - the well collection
    
    Returns:
    
    true on successful addition of all wells
  - add
```
public boolean add(Well[] array)
```
    Adds an array of wells to the well set.
    
    Parameters:
    
    Well[] - the well array
    
    Returns:
    
    true on successful addition of all wells
  - remove
```
public boolean remove(Well well)
```
    Removes a well from the well set.
    
    Parameters:
    
    int - the well
    
    Returns:
    
    true on successful well removal
  - remove
```
public boolean remove(WellSet set)
```
    Removes the wells in the input well set.
    
    Parameters:
    
    WellSet - the well set
    
    Returns:
    
    true on successful removal of all wells
  - remove
```
public boolean remove(Collection<Well> collection)
```
    Removes a collection of wells from the well set.
    
    Parameters:
    
    Collection - the well collection
    
    Returns:
    
    true on successful removal of all wells
  - remove
```
public boolean remove(Well[] array)
```
    Removes an array of wells from the well set.
    
    Parameters:
    
    Well[] - the well array
    
    Returns:
    
    true on successful removal of all wells
  - remove
```
public boolean remove(String wellList,
                      String delimiter)
```
    Removes a well or a list of delimiter separated wells.
    
    Parameters:
    
    String - the well or list of wells
    
    String - the list delimiter
    
    Returns:
    
    true on successful removal of all wells
  - remove
```
public boolean remove(String well)
```
    Removes the well with the well index.
    
    Parameters:
    
    String - the well index
    
    Returns:
    
    true on successful well removal
  - remove
```
public boolean remove(WellIndex index)
```
    Removes the well with the well index.
  - remove
```
public boolean remove(WellList list)
```
    Removes the wells in the list.
    
    Parameters:
    
    WellList - the well list
    
    Returns:
    
    true on successful removal
  - replace
```
public boolean replace(Well well)
```
    Replaces the set well with the input well. Adds the well if the well does not exist.
    
    Parameters:
    
    Well - the well for replacement
    
    Returns:
    
    true on successful well replacement
  - replace
```
public boolean replace(WellSet set)
```
    Replaces the set wells with the wells from the input set. Adds the well if the well does not exist.
    
    Parameters:
    
    WellSet - the well set
    
    Returns:
    
    true on successful replacement of all wells
  - replace
```
public boolean replace(Collection<Well> collection)
```
    Replaces the set wells with the wells from the collection. Adds the well if the well does not exist.
    
    Parameters:
    
    Collection - the data collection
    
    Returns:
    
    true on successful replacement of all wells
  - replace
```
public boolean replace(Well[] array)
```
    Replaces the set wells with the wells from the array. Adds the well data if the well does not exist.
    
    Parameters:
    
    Well[] - the array of wells
    
    Returns:
    
    true on successful replacement of all wells
  - retain
```
public boolean retain(Well well)
```
    Retains the input well if it exists.
    
    Parameters:
    
    Well - the well
    
    Returns:
    
    true on successful well retention
  - retain
```
public boolean retain(WellSet set)
```
    Retains the wells in the well set if they exist.
    
    Parameters:
    
    WellSet - the well set
    
    Returns:
    
    true on successful retention of all wells
  - retain
```
public boolean retain(Collection<Well> collection)
```
    Retains the wells in the collection if they exist.
    
    Parameters:
    
    Collection - the data collection
    
    Returns:
    
    true on successful retention of all wells
  - retain
```
public boolean retain(Well[] array)
```
    Retains the wells in the array if they exist.
    
    Parameters:
    
    WellInteger[] - the array of wells
    
    Returns:
    
    true on successful retention of all wells
  - retain
```
public boolean retain(String wellList,
                      String delimiter)
```
    Retain the wells in the delimiter separated list.
    
    Parameters:
    
    String - delimiter separated list of wells
    
    String - delimiter for the list of wells
    
    Returns:
    
    all wells with matching well indices or null
  - retain
```
public boolean retain(String well)
```
    Retains the well.
    
    Parameters:
    
    String - the well index
    
    Returns:
    
    true on successful retention
  - retain
```
public boolean retain(WellIndex index)
```
    Retains the well with the well index.
    
    Parameters:
    
    WellIndex - the well index
    
    Returns:
    
    true on successful retention
  - retain
```
public boolean retain(WellList list)
```
    Retains the wells in the list.
    
    Parameters:
    
    WellList - the well list
    
    Returns:
    
    true on successful retention
  - contains
```
public boolean contains(Well well)
```
    Returns true if the well is part of the well set.
    
    Parameters:
    
    Well - the well
    
    Returns:
    
    true if the well exists in the set
  - contains
```
public boolean contains(WellSet set)
```
    Returns true if all the input wells are found within the well set.
    
    Parameters:
    
    WellSet - the input wells
    
    Returns:
    
    true if all input wells are found within the set
  - contains
```
public boolean contains(Collection<Well> collection)
```
    Returns true if all the input wells are found within the well set.
    
    Parameters:
    
    Collection - the input wells
    
    Returns:
    
    true if all input wells are found within the set
  - contains
```
public boolean contains(Well[] array)
```
    Returns true if all the input wells are found within the well array.
    
    Parameters:
    
    WellInteger[] - the input wells
    
    Returns:
    
    true if all input wells are found within the set
  - contains
```
public boolean contains(String wellList,
                        String delimiter)
```
    Returns true if the wells are part of the set.
    
    Parameters:
    
    String - delimiter separated list of wells
    
    String - delimiter for the list of wells
    
    Returns:
    
    true if the wells exist in the sest
  - contains
```
public boolean contains(String well)
```
    Returns true if the well is part of the well set.
    
    Parameters:
    
    String - the well
    
    Returns:
    
    true if the well exists in the set
  - contains
```
public boolean contains(WellIndex index)
```
    Returns true if the well is part of the set.
    
    Parameters:
    
    WellIndex - the well index
    
    Returns:
    
    true if the well exists
  - contains
```
public boolean contains(WellList list)
```
    Returns true if the wells exist in the set.
    
    Parameters:
    
    WellList - the well list
    
    Returns:
    
    true if all the well exist
  - descendingIterator
```
public Iterator<Well> descendingIterator()
```
    Returns an iterator over the wells in this set in descending order.
    
    Returns:
    
    iterator for traversing set in descending order
  - descendingSet
```
public Set<Well> descendingSet()
```
    Returns a reverse order view of the wells contained in this set.
    
    Returns:
    
    the set in descending order
  - first
```
public Well first()
```
    Returns the first well in the set.
    
    Returns:
    
    the first well in the set
  - last
```
public Well last()
```
    Returns the last well in the set.
    
    Returns:
    
    the last well in the set
  - ceiling
```
public Well ceiling(Well well)
```
    Returns the least well in this set greater than or equal to the given well, or null if there is no such well.
    
    Parameters:
    
    Well - the well
    
    Returns:
    
    least well greater than or equal to the input well
  - floor
```
public Well floor(Well well)
```
    Returns the greatest well in this set less than or equal to the given well, or null if there is no such well.
    
    Returns:
    
    greatest well less than or equal to the input well
  - headSet
```
public Set<Well> headSet(Well well)
```
    Returns a view of the portion of this set whose wells are strictly less than the input well.
    
    Parameters:
    
    Well - input well
    
    Returns:
    
    well set with wells less than the input well
  - headSet
```
public Set<Well> headSet(Well well,
                         boolean inclusive)
```
    Returns a view of the portion of this set whose wells are less than (or equal to, if inclusive is true) to the input well.
    
    Parameters:
    
    Well - input well
    
    boolean - a true value retains the input well in the sub set
    
    Returns:
    
    well set with wells less than the input well
  - headSet
```
public Set<Well> headSet(int index)
```
    Returns a view of the portion of this set whose wells are less than or equal to the index.
    
    Parameters:
    
    Well - the input well
    
    Returns:
    
    set with wells less than or equal to the input well
  - headSet
```
public Set<Well> headSet(int index,
                         boolean inclusive)
```
    Returns a view of the portion of this set whose wells are less than (or equal to, if inclusive is true) the index.
    
    Parameters:
    
    Well - the input well
    
    Returns:
    
    set with wells less than or equal to the input well
  - higher
```
public Well higher(Well well)
```
    Returns the least well in this set strictly greater than the given well, or null if there is no such well.
    
    Parameters:
    
    Well - input well
    
    Returns:
    
    greatest well less than or equal to the input well
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this set contains no wells.
    
    Returns:
    
    greatest well less than or equal to the input well
  - iterator
```
public Iterator<Well> iterator()
```
    Returns an iterator over the wells in this set in ascending order.
    
    Specified by:
    
    iterator in interface Iterable<Well>
    
    Returns:
    
    iterator traversing set in ascending order
  - lower
```
public Well lower(Well well)
```
    Returns the greatest well in this set strictly less than the given well, or null if there is no such well.
    
    Parameters:
    
    Well - input well
    
    Returns:
    
    least well greater than or equal to the input well
  - pollFirst
```
public Well pollFirst()
```
    Retrieves and removes the first (lowest) well, or returns null if this set is empty.
    
    Returns:
    
    first/lowest well
  - pollLast
```
public Well pollLast()
```
    Retrieves and removes the last (highest) well, or returns null if this set is empty.
    
    Returns:
    
    last/highest well
  - subSet
```
public Set<Well> subSet(Well well1,
                        boolean inclusive1,
                        Well well2,
                        boolean inclusive2)
```
    Returns a view of the portion of this set whose wells range from the first input well to the second input well.
    
    Parameters:
    
    Well - the first input well
    
    Well - the second input well
    
    boolean - includes the first input well in the returned set
    
    boolean - includes the second input well in the returned set
    
    Returns:
    
    last well in the set
  - subSet
```
public Set<Well> subSet(Well well1,
                        Well well2)
```
    Returns a view of the portion of this set whose wells range from the first input well inclusive to the second input well inclusive.
    
    Parameters:
    
    Well - the first input well
    
    Well - the second input well
    
    Returns:
    
    last well in the set
  - subSet
```
public Set<Well> subSet(int index1,
                        boolean inclusive1,
                        int index2,
                        boolean inclusive2)
```
    Returns a view of the portion of this set between the indices.
    
    Parameters:
    
    int - the first index
    
    int - the second index
    
    boolean - includes the first input well in the returned set
    
    boolean - includes the second input well in the returned set
    
    Returns:
    
    last well in the set
  - subSet
```
public Set<Well> subSet(int index1,
                        int index2)
```
    Returns a view of the portion of this set between the indices.
    
    Parameters:
    
    int - the first index
    
    int - the second index
    
    Returns:
    
    the subset
  - tailSet
```
public Set<Well> tailSet(Well well)
```
    Returns a view of the portion of this set whose wells are greater than or equal to the input well.
    
    Parameters:
    
    Well - the input well
    
    Returns:
    
    set with wells greater than or equal to the input well
  - tailSet
```
public Set<Well> tailSet(Well well,
                         boolean inclusive)
```
    Returns a view of the portion of this set whose wells are greater than (or equal to, if inclusive is true) the input well.
    
    Parameters:
    
    Well - the input well
    
    Returns:
    
    set with wells greater than or equal to the input well
  - tailSet
```
public Set<Well> tailSet(int index)
```
    Returns a view of the portion of this set whose wells are greater than or equal to the index.
    
    Parameters:
    
    Well - the input well
    
    Returns:
    
    set with wells greater than or equal to the input well
  - tailSet
```
public Set<Well> tailSet(int index,
                         boolean inclusive)
```
    Returns a view of the portion of this set whose wells are greater than (or equal to, if inclusive is true) the index.
    
    Parameters:
    
    Well - the input well
    
    Returns:
    
    set with wells greater than or equal to the input well
  - allWells
```
public Set<Well> allWells()
```
    Returns the well set.
    
    Returns:
    
    the well set
  - getWells
```
public Well getWells(Well input)
```
    Returns the well or null if no such well exists.
    
    Parameters:
    
    Well - the well
    
    Returns:
    
    the plate well or null if the well does not exist
  - getWells
```
public WellSet getWells(WellSet input)
```
    Returns a well set holding all plate wells that match the indices or null if there are no matches.
    
    Parameters:
    
    WellSet - the input well set
    
    Returns:
    
    the output well set
  - getWells
```
public WellSet getWells(Collection<Well> collection)
```
    Returns a well set holding all plate wells that match the indices or null if there are no matches.
    
    Parameters:
    
    Collection - collection of wells
    
    Returns:
    
    all wells with matching well indices or null
  - getWells
```
public WellSet getWells(Well[] array)
```
    Returns a well set holding all wells that match the indices or null if there are no matches.
    
    Parameters:
    
    WellInteger[] - array of well indices
    
    Returns:
    
    all wells with matching well indices or null
  - getWells
```
public WellSet getWells(String wellList,
                        String delimiter)
```
    Returns a well set holding all plate wells that match the indices or null if there are no matches.
    
    Parameters:
    
    String - delimiter separated list of wells
    
    String - delimiter for the list of wells
    
    Returns:
    
    all wells with matching well indices or null
  - getWells
```
public Well getWells(String well)
```
    Returns the well with the input indices.
    
    Parameters:
    
    String - the well index
    
    Returns:
    
    well with matching well ID
  - getWells
```
public Well getWells(WellIndex index)
```
    Returns the well or null if the well does not exist.
    
    Parameters:
    
    WellIndex - the well index
    
    Returns:
    
    the well
  - getWells
```
public WellSet getWells(WellList list)
```
    Returns a well set containing the wells in the list or null if none of the wells exist.
    
    Parameters:
    
    WellList - the well list
    
    Returns:
    
    the wells
  - getRow
```
public WellSet getRow(int row)
```
    Returns all wells with the matching row index.
    
    Parameters:
    
    int - the row index
    
    Returns:
    
    wells with matching row index
  - getColumn
```
public WellSet getColumn(int column)
```
    Returns all wells with the matching column index.
    
    Parameters:
    
    int - the row index
    
    Returns:
    
    wells with the matching column index
  - clear
```
public void clear()
```
    Clears the set.
  - toWellArray
```
public Well[] toWellArray()
```
    Returns the well set as an array of wells.
    
    Returns:
    
    array of wells
  - setLabel
```
public void setLabel(String label)
```
    Sets the set label.
    
    Parameters:
    
    String - the new label
  - size
```
public int size()
```
    Returns the size of the well set.
    
    Returns:
    
    size of the well set
  - wellList
```
public WellList wellList()
```
    Returns all indices in the set in a well list.
    
    Returns:
    
    the list of well indices
  - toStringArray
```
public String[] toStringArray()
```
    Returns the well set as an array of well IDs.
    
    Returns:
    
    the array of well IDs
  - label
```
public String label()
```
    Returns the label.
    
    Returns:
    
    label
  - toString
```
public String toString()
```
    Returns a string containing the label and wells.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    label and well IDs
  - equals
```
public boolean equals(Object object)
```
    Well sets are equivalent if they contain the same wells and label.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    Object - the object
    
    Returns:
    
    true if equal, false otherwise
  - hashCode
```
public int hashCode()
```
    Hash code uses the wells and label.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code
  - compareTo
```
public int compareTo(WellSet set)
```
    Compares two well set objects.
    
    Specified by:
    
    compareTo in interface Comparable<WellSet>

Class WellSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

WellSet

WellSet

WellSet

WellSet

WellSet

WellSet

WellSet

Method Detail

add

add

add

add

remove

remove

remove

remove

remove

remove

remove

remove

replace

replace

replace

replace

retain

retain

retain

retain

retain

retain

retain

retain

contains

contains

contains

contains

contains

contains

contains

contains

descendingIterator

descendingSet

first

last

ceiling

floor

headSet

headSet

headSet

headSet

higher

isEmpty

iterator

lower

pollFirst

pollLast

subSet

subSet

subSet

subSet

tailSet

tailSet

tailSet

tailSet

allWells

getWells

getWells

getWells

getWells

getWells

getWells

getWells

getWells

getRow