org.jlab.coda.eventViewer

Enum DictionarySource

java.lang.Object

java.lang.Enum<DictionarySource>

org.jlab.coda.eventViewer.DictionarySource

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DictionarySource>

public enum DictionarySource
extends java.lang.Enum<DictionarySource>

This enum contains the choices for a source of dictionary.

Author:

timmer Feb 21, 2013

Enum Constant Summary

Enum Constants

Enum Constant and Description
CMSG
ET
EVIOFILE
NONE
XML

Method Summary

Modifier and Type	Method and Description
org.jlab.coda.jevio.EvioXMLDictionary	getDictionary() Get the associated dictionary object.
java.lang.String	getXML() Get the associated xml string dictionary.
void	setDictionary(org.jlab.coda.jevio.EvioXMLDictionary dictionary) Set both the string and object forms of a dictionary to be associated with a particular dictionary source.
static DictionarySource	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DictionarySource[]	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

EVIOFILE

public static final DictionarySource EVIOFILE

XML

public static final DictionarySource XML

CMSG

public static final DictionarySource CMSG

ET

public static final DictionarySource ET

NONE

public static final DictionarySource NONE

Method Detail

values

public static DictionarySource[] 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 (DictionarySource c : DictionarySource.values())
    System.out.println(c);

Returns:

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

valueOf

public static DictionarySource valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

setDictionary

public void setDictionary(org.jlab.coda.jevio.EvioXMLDictionary dictionary)

Set both the string and object forms of a dictionary to be associated with a particular dictionary source.

Parameters:

dictionary - dictionary object

getXML

public java.lang.String getXML()

Get the associated xml string dictionary.

Returns:

associated xml string dictionary.

getDictionary

public org.jlab.coda.jevio.EvioXMLDictionary getDictionary()

Get the associated dictionary object.

Returns:

associated dictionary object.