uk.ac.ebi.intenz.domain.enzyme

Class EnzymeClass

java.lang.Object

uk.ac.ebi.intenz.domain.enzyme.EnzymeClass

All Implemented Interfaces:

Comparable<EnzymeClass>

public class EnzymeClass
extends Object
implements Comparable<EnzymeClass>

This class represents an enzyme class of the Enzyme Nomenclature.

Instances of this class are immutable.

Version:

$Revision: 1.2 $ $Date: 2008/01/28 12:33:00 $

Author:

Michael Darsow

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(EnzymeClass enzymeClass) Makes instances of this class comparable.
boolean	equals(Object o) Standard equals method.
String	getDescription()
EnzymeCommissionNumber	getEc() Returns the hash code of this object.
String	getName()
List<EnzymeSubclass>	getSubclasses()
int	hashCode()
static EnzymeClass	valueOf(EnzymeCommissionNumber ec, String name, String description, List<EnzymeSubclass> subclasses) Returns an EnzymeClass instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

valueOf

public static EnzymeClass valueOf(EnzymeCommissionNumber ec,
                  String name,
                  String description,
                  List<EnzymeSubclass> subclasses)

Returns an EnzymeClass instance.

Parameters:

ec - The class' EC.

name - The name of the class.

description - The description of the class.

subclasses - The list of subclasses (see EnzymeSubclass).

Throws:

NullPointerException - if any parameter is null.

IllegalArgumentException - if name or the list of subclasses is empty.

compareTo

public int compareTo(EnzymeClass enzymeClass)

Makes instances of this class comparable.

Specified by:

compareTo in interface Comparable<EnzymeClass>

Parameters:

enzymeClass - The object to be compared to this instance.

Returns:

a pos. integer if this instance is greater than, a neg. integer if it is less than or 0 if it equals o.

equals

public boolean equals(Object o)

Standard equals method.

Overrides:

equals in class Object

Parameters:

o - Object to be compared to this one.

Returns:

true if the objects are equal.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getEc

public EnzymeCommissionNumber getEc()

Returns the hash code of this object.

Returns:

the hash code of this object.

getName

public String getName()

getDescription

public String getDescription()

getSubclasses

public List<EnzymeSubclass> getSubclasses()