Enum ResidueType
- All Implemented Interfaces:
Serializable,Comparable<ResidueType>,java.lang.constant.Constable
Registry of known residues. Provides mapping between enum representation and one- and three-letter codes as well as
polymer type.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionAdenosineAlanineArginineAsparagineAspartic acidCysteineCytidineDeoxyadenosineDeoxycytidineDeoxyguanosineGlutamic acidGlutamineGlycineGuanosineHistidineIsoleucineLeucineLysineMethioninePhenylalanineProlineSerineThreonineThymidineTryptophanTyrosineSome unknown amino acid.Some unknown, yet polymeric component.Some unknown nucleotide.UridineValine -
Method Summary
Modifier and TypeMethodDescriptionThe one-letter code of this residue.The polymer type of this residue.The (up to) three-letter code of this residue.static ResidueTypeofOneLetterCode(String oneLetterCode) Resolve a one-letter-code.static ResidueTypeofThreeLetterCode(String labelCompId) Maps labelCompId values to the correctResidueType.static ResidueTypeReturns the enum constant of this type with the specified name.static ResidueType[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
ALANINE
Alanine -
CYSTEINE
Cysteine -
ASPARTIC_ACID
Aspartic acid -
GLUTAMIC_ACID
Glutamic acid -
PHENYLALANINE
Phenylalanine -
GLYCINE
Glycine -
HISTIDINE
Histidine -
ISOLEUCINE
Isoleucine -
LYSINE
Lysine -
LEUCINE
Leucine -
METHIONINE
Methionine -
ASPARAGINE
Asparagine -
PROLINE
Proline -
GLUTAMINE
Glutamine -
ARGININE
Arginine -
SERINE
Serine -
THREONINE
Threonine -
VALINE
Valine -
TRYPTOPHAN
Tryptophan -
TYROSINE
Tyrosine -
ADENOSINE
Adenosine -
CYTIDINE
Cytidine -
DEOXYADENOSINE
Deoxyadenosine -
DEOXYCYTIDINE
Deoxycytidine -
DEOXYGUANOSINE
Deoxyguanosine -
GUANOSINE
Guanosine -
THYMIDINE
Thymidine -
URIDINE
Uridine -
UNKNOWN_AMINO_ACID
Some unknown amino acid. -
UNKNOWN_NUCLEOTIDE
Some unknown nucleotide. -
UNKNOWN_COMPONENT
Some unknown, yet polymeric component.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException- if the argument is null
-
getThreeLetterCode
The (up to) three-letter code of this residue. Matches labelCompId.- Returns:
- a String
-
getOneLetterCode
The one-letter code of this residue. May be 'artificial'/nonstandard. Used e.g. to name inverted index files.- Returns:
- a String
-
getPolymerType
The polymer type of this residue.- Returns:
- amino acid or nucleotide
-
ofThreeLetterCode
Maps labelCompId values to the correctResidueType.- Parameters:
labelCompId- three-letter code to process- Returns:
- the matching type - if argument is null or fail to find: return UNKNOWN_AMINO_ACID
-
ofOneLetterCode
Resolve a one-letter-code.- Parameters:
oneLetterCode- the one-letter-code (as defined in this implementation)- Returns:
- a residue type or null
-