de.bioforscher.singa.structure.parser.pdb.structures.tokens

Enum ChainTerminatorToken

java.lang.Object

java.lang.Enum<ChainTerminatorToken>

de.bioforscher.singa.structure.parser.pdb.structures.tokens.ChainTerminatorToken

All Implemented Interfaces:

PDBToken, Serializable, Comparable<ChainTerminatorToken>

public enum ChainTerminatorToken
extends Enum<ChainTerminatorToken>
implements PDBToken

Author:

cl

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATOM_SERIAL
CHAIN_IDENTIFIER
RECORD_TYPE
RESIDUE_INSERTION
RESIDUE_NAME
RESIDUE_SERIAL

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	RECORD_PATTERN A pattern describing all record names associated with this token structure.

Method Summary

Modifier and Type	Method and Description
static String	assemblePDBLine(LeafSubstructure lastLeafOfChain) Creates a terminate record from the last leaf in the consecutive part of a chain.
de.bioforscher.singa.core.utility.Range<Integer>	getColumns() Gets the columns (the staring and ending index) where a value can be extracted.
Pattern	getRecordNamePattern() Returns the record name for this token.
static ChainTerminatorToken	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChainTerminatorToken[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.bioforscher.singa.structure.parser.pdb.structures.tokens.PDBToken

endLine, extract, extractValueFromPDBLine

Enum Constant Detail

RECORD_TYPE

public static final ChainTerminatorToken RECORD_TYPE

ATOM_SERIAL

public static final ChainTerminatorToken ATOM_SERIAL

RESIDUE_NAME

public static final ChainTerminatorToken RESIDUE_NAME

CHAIN_IDENTIFIER

public static final ChainTerminatorToken CHAIN_IDENTIFIER

RESIDUE_SERIAL

public static final ChainTerminatorToken RESIDUE_SERIAL

RESIDUE_INSERTION

public static final ChainTerminatorToken RESIDUE_INSERTION

Field Detail

RECORD_PATTERN

public static final Pattern RECORD_PATTERN

A pattern describing all record names associated with this token structure. Use this to filter for lines that are parsable with this token.

Method Detail

values

public static ChainTerminatorToken[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ChainTerminatorToken c : ChainTerminatorToken.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ChainTerminatorToken valueOf(String name)

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 name

NullPointerException - if the argument is null

assemblePDBLine

public static String assemblePDBLine(LeafSubstructure lastLeafOfChain)

Creates a terminate record from the last leaf in the consecutive part of a chain.

Parameters:

lastLeafOfChain - The last leaf in the consecutive part of a chain.

Returns:

The terminate record.

getRecordNamePattern

public Pattern getRecordNamePattern()

Description copied from interface: PDBToken

Returns the record name for this token.

Specified by:

getRecordNamePattern in interface PDBToken

Returns:

The record name for this token.

getColumns

public de.bioforscher.singa.core.utility.Range<Integer> getColumns()

Description copied from interface: PDBToken

Gets the columns (the staring and ending index) where a value can be extracted.

Specified by:

getColumns in interface PDBToken

Returns:

The columns where a value can be extracted.