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

Enum HeaderToken

java.lang.Object

java.lang.Enum<HeaderToken>

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

All Implemented Interfaces:

PDBToken, Serializable, Comparable<HeaderToken>

public enum HeaderToken
extends Enum<HeaderToken>
implements PDBToken

Author:

cl

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLASSIFICATION
DEPOSITION_DATE
ID_CODE

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	RECORD_PATTERN

Method Summary

Modifier and Type	Method and Description
static String	assemblePDBLine(String pdbIdentifier)
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 HeaderToken	valueOf(String name) Returns the enum constant of this type with the specified name.
static HeaderToken[]	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

CLASSIFICATION

public static final HeaderToken CLASSIFICATION

DEPOSITION_DATE

public static final HeaderToken DEPOSITION_DATE

ID_CODE

public static final HeaderToken ID_CODE

Field Detail

RECORD_PATTERN

public static final Pattern RECORD_PATTERN

Method Detail

values

public static HeaderToken[] 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 (HeaderToken c : HeaderToken.values())
    System.out.println(c);

Returns:

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

valueOf

public static HeaderToken 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(String pdbIdentifier)

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.