org.sbml.jsbml.ext.layout

Enum SpeciesReferenceRole

java.lang.Object

java.lang.Enum<SpeciesReferenceRole>

org.sbml.jsbml.ext.layout.SpeciesReferenceRole

All Implemented Interfaces:

Serializable, Comparable<SpeciesReferenceRole>

public enum SpeciesReferenceRole
extends Enum<SpeciesReferenceRole>

Enumeration that defines the different SpeciesReferenceRoles that are encoded by the Layout package.

Since:

1.0

Author:

Nicolas Rodriguez, Andreas Dräger

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVATOR
INHIBITOR
MODIFIER
PRODUCT
SIDEPRODUCT
SIDESUBSTRATE
SUBSTRATE
UNDEFINED

Method Summary

Modifier and Type	Method and Description
int	toSBOterm()
static SpeciesReferenceRole	valueOf(int sboTerm)
static SpeciesReferenceRole	valueOf(String name) Returns the enum constant of this type with the specified name.
static SpeciesReferenceRole[]	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

ACTIVATOR

public static final SpeciesReferenceRole ACTIVATOR

INHIBITOR

public static final SpeciesReferenceRole INHIBITOR

MODIFIER

public static final SpeciesReferenceRole MODIFIER

PRODUCT

public static final SpeciesReferenceRole PRODUCT

SIDEPRODUCT

public static final SpeciesReferenceRole SIDEPRODUCT

SIDESUBSTRATE

public static final SpeciesReferenceRole SIDESUBSTRATE

SUBSTRATE

public static final SpeciesReferenceRole SUBSTRATE

UNDEFINED

public static final SpeciesReferenceRole UNDEFINED

Method Detail

values

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

Returns:

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

valueOf

public static SpeciesReferenceRole 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

toSBOterm

public int toSBOterm()

Returns:

valueOf

public static SpeciesReferenceRole valueOf(int sboTerm)

Parameters:

sboTerm -

Returns:

the SpeciesReferenceRole for the given SBO term identifier.