Package org.biojava.nbio.structure.scop

Enum ScopCategory

java.lang.Object

java.lang.Enum<ScopCategory>

org.biojava.nbio.structure.scop.ScopCategory

All Implemented Interfaces:

Serializable, Comparable<ScopCategory>

public enum ScopCategory
extends Enum<ScopCategory>
implements Serializable

The various categories provided by SCOP. The SCOP node types are 'cl' (Class), 'cf' (Fold), 'sf' (Superfamily), 'fa' (Family), 'dm' (Domain), 'sp' (Species), 'px' (protein).

Author:

Andreas Prlic

Enum Constant Summary

Enum Constants

Enum Constant	Description
Class
Domain
Family
Fold
Px
Species
Superfamily

Method Summary

Modifier and Type	Method	Description
static ScopCategory	fromString(String type)
String	toString()
static ScopCategory	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ScopCategory[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Class

public static final ScopCategory Class

Fold

public static final ScopCategory Fold

Superfamily

public static final ScopCategory Superfamily

Family

public static final ScopCategory Family

Domain

public static final ScopCategory Domain

Species

public static final ScopCategory Species

Px

public static final ScopCategory Px

Method Detail

values

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

Returns:

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

valueOf

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

fromString

public static ScopCategory fromString(String type)

toString

public String toString()

Overrides:

toString in class Enum<ScopCategory>