PdbNamedResidueIdentifier (BioCommons 3.0.4 API)

java.lang.Object
- pl.poznan.put.pdb.PdbNamedResidueIdentifier

All Implemented Interfaces:

Serializable, Comparable<ChainNumberICode>, ChainNumberICode

Direct Known Subclasses:

ImmutablePdbNamedResidueIdentifier
```
@Immutable
public abstract class PdbNamedResidueIdentifier
extends Object
implements ChainNumberICode, Serializable
```
Class that represents a residue identifier with a known name. In some cases, the name is known only after post-processing e.g. when finding out the name of a residue based on the atom content.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

PdbNamedResidueIdentifier()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract String`	`chainIdentifier()`
`abstract String`	`insertionCode()`
`abstract char`	`oneLetterName()`
`abstract int`	`residueNumber()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface pl.poznan.put.pdb.ChainNumberICode
compareTo

- Constructor Detail
  - PdbNamedResidueIdentifier
```
public PdbNamedResidueIdentifier()
```
- Method Detail
  - chainIdentifier
```
@Parameter(order=1)
public abstract String chainIdentifier()
```
    Specified by:
    
    chainIdentifier in interface ChainNumberICode
    
    Returns:
    
    The identifier of the chain a residue belongs to.
  - residueNumber
```
@Parameter(order=2)
public abstract int residueNumber()
```
    Specified by:
    
    residueNumber in interface ChainNumberICode
    
    Returns:
    
    The number of a residue in the chain.
  - insertionCode
```
@Parameter(order=3)
public abstract String insertionCode()
```
    Specified by:
    
    insertionCode in interface ChainNumberICode
    
    Returns:
    
    Optional insertion code, used in some PDB and mmCIF files to represent "inserted" residues while maintaining the original numbering.
  - oneLetterName
```
@Parameter(order=4)
public abstract char oneLetterName()
```
    Returns:
    
    The one letter name of the residue.
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object