com.github.jessemull.microflexinteger.io

Class WellListXML

java.lang.Object

com.github.jessemull.microflexinteger.io.WellListXML

All Implemented Interfaces:

Iterable<WellXML>

public class WellListXML
extends Object
implements Iterable<WellXML>

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

Author:

Jesse L. Mull

Constructor Summary

Constructors

Constructor and Description
WellListXML()
WellListXML(Collection<Well> collection) Creates an XML well list from a collection of well objects.
WellListXML(Well well) Creates an XML well list from a well object.
WellListXML(Well[] array) Creates an XML well list from an array of well objects.

Method Summary

Modifier and Type	Method and Description
WellXML	get(int index) Returns the XML well at the indicated index.
List<WellXML>	getWells() Gets the list of XML wells.
Iterator<WellXML>	iterator() Returns an iterator for the list of XML wells.
void	setWells(List<WellXML> wells) Sets the list of XML wells.
int	size() Returns the size of the XML well 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

WellListXML

public WellListXML()

WellListXML

public WellListXML(Well well)

Creates an XML well list from a well object.

Parameters:

Well - the well object

WellListXML

public WellListXML(Collection<Well> collection)

Creates an XML well list from a collection of well objects.

Parameters:

Collection - collection of well objects

WellListXML

public WellListXML(Well[] array)

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

Parameters:

WellInteger[] - array of well objects

Method Detail

setWells

public void setWells(List<WellXML> wells)

Sets the list of XML wells.

Parameters:

List - the new list of wells

getWells

public List<WellXML> getWells()

Gets the list of XML wells.

Returns:

the list of wells

get

public WellXML get(int index)

Returns the XML well at the indicated index.

Parameters:

int - the index into the well list

Returns:

the XML well

iterator

public Iterator<WellXML> iterator()

Returns an iterator for the list of XML wells.

Specified by:

iterator in interface Iterable<WellXML>

Returns:

the iterator

size

public int size()

Returns the size of the XML well list.

Returns:

the size of the list