Package repast.simphony.integration

Enum DataFileElementWriter

java.lang.Object

java.lang.Enum<DataFileElementWriter>

repast.simphony.integration.DataFileElementWriter

All Implemented Interfaces:

Serializable, Comparable<DataFileElementWriter>

public enum DataFileElementWriter
extends Enum<DataFileElementWriter>

Author:

Jerry Vos

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARRAY
BRANCH
DATA
FILE_DEF
RECORD
TABLE

Field Summary

Fields

Modifier and Type	Field	Description
String	tag

Method Summary

Modifier and Type	Method	Description
static DataFileElementWriter	getElementHandler(org.jdom.Element nodeToHandle)
abstract void	handle(DataFileWriter writerInst, Object parentContext, org.jdom.Element dataDescriptor)	Handles the specified nodeToParse.
static DataFileElementWriter	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DataFileElementWriter[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FILE_DEF

public static final DataFileElementWriter FILE_DEF

DATA

public static final DataFileElementWriter DATA

RECORD

public static final DataFileElementWriter RECORD

ARRAY

public static final DataFileElementWriter ARRAY

TABLE

public static final DataFileElementWriter TABLE

BRANCH

public static final DataFileElementWriter BRANCH

Field Detail

tag

public final String tag

Method Detail

values

public static DataFileElementWriter[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DataFileElementWriter c : DataFileElementWriter.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DataFileElementWriter valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getElementHandler

public static DataFileElementWriter getElementHandler(org.jdom.Element nodeToHandle)

handle

public abstract void handle(DataFileWriter writerInst,
                            Object parentContext,
                            org.jdom.Element dataDescriptor)
                     throws IOException

Handles the specified nodeToParse. Any elements to be added to the data tree should be added in this method and also returned by this method.

Parameters:

writerInst - the instance of the parser that this is working on

dataParent - the parent Element in the data tree that new data should be appended too

nodeToHandle - the node providing data

Throws:

Exception

IOException