org.sbml.jsbml

Enum ListOf.Type

java.lang.Object

java.lang.Enum<ListOf.Type>

org.sbml.jsbml.ListOf.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ListOf.Type>

Enclosing class:

ListOf<T extends SBase>

public static enum ListOf.Type
extends java.lang.Enum<ListOf.Type>

This enum lists all the possible names of the listXXX components. If the listXXX is a SBML package extension, the SBaseListType value to set would be 'other'.

Author:

Marine Dumousseau

Enum Constant Summary

Enum Constants

Enum Constant and Description
listOfCompartments
listOfCompartmentTypes
listOfConstraints
listOfEventAssignments
listOfEvents
listOfFunctionDefinitions
listOfInitialAssignments
listOfLocalParameters
listOfModifiers
listOfParameters
listOfProducts
listOfReactants
listOfReactions
listOfRules
listOfSpecies
listOfSpeciesTypes
listOfUnitDefinitions
listOfUnits
none Indicates that the ListOf.Type is not known yet or has not been configured so far.
other For instance, it is not possible to decide between reactants and products because both elements are of the same type.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Class<? extends SBase>	toClass() Gives the corresponding Class object for this ListOf.Type.
static ListOf.Type	valueOf(java.lang.Class<? extends SBase> type) Gives the corresponding ListOf.Type for the given Class object.
static ListOf.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ListOf.Type[]	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

listOfCompartments

public static final ListOf.Type listOfCompartments

listOfCompartmentTypes

public static final ListOf.Type listOfCompartmentTypes

listOfConstraints

public static final ListOf.Type listOfConstraints

listOfEventAssignments

public static final ListOf.Type listOfEventAssignments

listOfEvents

public static final ListOf.Type listOfEvents

listOfFunctionDefinitions

public static final ListOf.Type listOfFunctionDefinitions

listOfInitialAssignments

public static final ListOf.Type listOfInitialAssignments

listOfLocalParameters

public static final ListOf.Type listOfLocalParameters

listOfModifiers

public static final ListOf.Type listOfModifiers

listOfParameters

public static final ListOf.Type listOfParameters

listOfProducts

public static final ListOf.Type listOfProducts

listOfReactants

public static final ListOf.Type listOfReactants

listOfReactions

public static final ListOf.Type listOfReactions

listOfRules

public static final ListOf.Type listOfRules

listOfSpecies

public static final ListOf.Type listOfSpecies

listOfSpeciesTypes

public static final ListOf.Type listOfSpeciesTypes

listOfUnitDefinitions

public static final ListOf.Type listOfUnitDefinitions

listOfUnits

public static final ListOf.Type listOfUnits

none

public static final ListOf.Type none

Indicates that the ListOf.Type is not known yet or has not been configured so far.

other

public static final ListOf.Type other

For instance, it is not possible to decide between reactants and products because both elements are of the same type. Also in the extension packages this type is required.

Method Detail

values

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

Returns:

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

valueOf

public static ListOf.Type 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

valueOf

public static ListOf.Type valueOf(java.lang.Class<? extends SBase> type)

Gives the corresponding ListOf.Type for the given Class object. However, in the case of listOfReactants and listOfProducts it is not possible to make a distinction because both types refer to the same Class object. Therefore, in this case this method will return the type other, which is to be clearly distinguished from none.

Parameters:

type -

Returns:

toClass

public java.lang.Class<? extends SBase> toClass()

Gives the corresponding Class object for this ListOf.Type. However, in case of listOfReactants and listOfProducts the same Class object is returned.

Returns: