com.github.jessemull.microflexinteger.io

Class WellSetListXML

java.lang.Object

com.github.jessemull.microflexinteger.io.WellSetListXML

All Implemented Interfaces:

Iterable<WellSetXML>

public class WellSetListXML
extends Object
implements Iterable<WellSetXML>

This is a wrapper class used to marshal/unmarshal a list of XML encoded well set objects.

Author:

Jesse L. Mull

Constructor Summary

Constructors

Constructor and Description
WellSetListXML()
WellSetListXML(Collection<WellSet> collection) Creates an xml well set list from a collection of well set objects.
WellSetListXML(WellSet single) Creates an xml well set list from a well set object.
WellSetListXML(WellSet[] array) Creates an XML well set list from an array of well set objects.

Method Summary

Modifier and Type	Method and Description
WellSetXML	get(int index) Returns the XML well set at the indicated index.
List<WellSetXML>	getWellsets() Returns the list of XML sets.
Iterator<WellSetXML>	iterator() Returns an iterator for the list of well sets.
void	setWellsets(List<WellSetXML> wellsets) Sets the list of XML well sets.
int	size() Returns the size of the well set list.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

WellSetListXML

public WellSetListXML()

WellSetListXML

public WellSetListXML(WellSet single)

Creates an xml well set list from a well set object.

Parameters:

WellSet - the well set object

WellSetListXML

public WellSetListXML(Collection<WellSet> collection)

Creates an xml well set list from a collection of well set objects.

Parameters:

Collection - the collection of sets

WellSetListXML

public WellSetListXML(WellSet[] array)

Creates an XML well set list from an array of well set objects.

Parameters:

WellSet - the well set object

Method Detail

setWellsets

public void setWellsets(List<WellSetXML> wellsets)

Sets the list of XML well sets.

Parameters:

List - the new list of XML well sets

getWellsets

public List<WellSetXML> getWellsets()

Returns the list of XML sets.

Returns:

the list of well sets

get

public WellSetXML get(int index)

Returns the XML well set at the indicated index.

Parameters:

int - the index into the well list

Returns:

the well set POJO

iterator

public Iterator<WellSetXML> iterator()

Returns an iterator for the list of well sets.

Specified by:

iterator in interface Iterable<WellSetXML>

Returns:

the iterator

size

public int size()

Returns the size of the well set list.

Returns:

the size of the list