uk.ac.ebi.intenz.domain.enzyme

Class EnzymeSubclass

java.lang.Object

uk.ac.ebi.intenz.domain.enzyme.EnzymeSubclass

All Implemented Interfaces:

Comparable<EnzymeSubclass>

public class EnzymeSubclass
extends Object
implements Comparable<EnzymeSubclass>

This class represents an enzyme subclass of the Enzyme Nomenclature.

Instances of this class are immutable.

Version:

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

Author:

Michael Darsow

Constructor Summary

Constructors

Constructor and Description
EnzymeSubclass(EnzymeCommissionNumber ec, String className, String name, String description, List<EnzymeSubSubclass> subSubclasses) Returns an EnzymeSubclass instance.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(EnzymeSubclass enzymeSubclass) Makes instances of this class comparable.
boolean	equals(Object o) Standard equals method.
String	getClassName()
String	getDescription()
EnzymeCommissionNumber	getEc()
String	getName()
List<EnzymeSubSubclass>	getSubSubclasses()
int	hashCode() Returns the hash code of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnzymeSubclass

public EnzymeSubclass(EnzymeCommissionNumber ec,
              String className,
              String name,
              String description,
              List<EnzymeSubSubclass> subSubclasses)

Returns an EnzymeSubclass instance.

Parameters:

ec - The class' EC.

className - The name of the class.

name - The name of the subclass.

description - The description of the class.

subSubclasses - The list of sub-subclasses (see EnzymeSubSubclass).

Throws:

NullPointerException - if any of the parameters is null.

IllegalArgumentException - if the list of sub-subclasses is empty.

Method Detail

compareTo

public int compareTo(EnzymeSubclass enzymeSubclass)

Makes instances of this class comparable.

Specified by:

compareTo in interface Comparable<EnzymeSubclass>

Parameters:

enzymeSubclass - 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()

Returns the hash code of this object.

Overrides:

hashCode in class Object

Returns:

the hash code of this object.

getEc

public EnzymeCommissionNumber getEc()

getClassName

public String getClassName()

getName

public String getName()

getDescription

public String getDescription()

getSubSubclasses

public List<EnzymeSubSubclass> getSubSubclasses()