Package pl.poznan.put.pdb

Class PdbResidueIdentifier

java.lang.Object

pl.poznan.put.pdb.PdbResidueIdentifier

All Implemented Interfaces:

Serializable, Comparable<ChainNumberICode>, ChainNumberICode

Direct Known Subclasses:

ImmutablePdbResidueIdentifier

@Immutable
public abstract class PdbResidueIdentifier
extends Object
implements ChainNumberICode

A residue identifier is used only to address a residue in the structure. To work with residue content, see DefaultPdbResidue.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PdbResidueIdentifier()

Method Summary

Modifier and Type	Method	Description
abstract String	chainIdentifier()
static PdbResidueIdentifier	from(ChainNumberICode chainNumberICode)	Creates an instance of this class from any implementation of ChainNumberICode.
abstract Optional<String>	insertionCode()
abstract int	residueNumber()
final 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 Details

PdbResidueIdentifier

public PdbResidueIdentifier()

Method Details

from

public static PdbResidueIdentifier from(ChainNumberICode chainNumberICode)

Creates an instance of this class from any implementation of ChainNumberICode.

Parameters:

chainNumberICode - The instance of (chain, number, icode) to convert.

Returns:

An object that can be used to address specific residue.

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 Optional<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.

toString

public final String toString()

Overrides:

toString in class Object