AtomToken (singa-structure 0.3.3 API)

java.lang.Object
- java.lang.Enum<AtomToken>
- - de.bioforscher.singa.structure.parser.pdb.structures.tokens.AtomToken

All Implemented Interfaces:

PDBToken, Serializable, Comparable<AtomToken>
```
public enum AtomToken
extends Enum<AtomToken>
implements PDBToken
```
The atom and hetatm token. Containing information of atoms.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALTERNATE_LOCATION_INDICATOR`
`ATOM_NAME`
`ATOM_SERIAL`
`CHAIN_IDENTIFIER`
`ELEMENT_CHARGE`
`ELEMENT_SYMBOL`
`OCCUPANCY`
`RECORD_TYPE`
`RESIDUE_INSERTION`
`RESIDUE_NAME`
`RESIDUE_SERIAL`
`TEMPERATURE_FACTOR`
`X_COORDINATE`
`Y_COORDINATE`
`Z_COORDINATE`

Field Summary

Fields
Modifier and Type Field and Description

static Pattern RECORD_PATTERN

Fields
Modifier and Type	Field and Description
`static Pattern`	`RECORD_PATTERN`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static OakAtom`	`assembleAtom(String atomLine)`
`static List<String>`	`assemblePDBLine(LeafSubstructure leaf)`
`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 AtomToken`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AtomToken[]`	`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 AtomToken RECORD_TYPE
```
  - ATOM_SERIAL
```
public static final AtomToken ATOM_SERIAL
```
  - ATOM_NAME
```
public static final AtomToken ATOM_NAME
```
  - ALTERNATE_LOCATION_INDICATOR
```
public static final AtomToken ALTERNATE_LOCATION_INDICATOR
```
  - RESIDUE_NAME
```
public static final AtomToken RESIDUE_NAME
```
  - CHAIN_IDENTIFIER
```
public static final AtomToken CHAIN_IDENTIFIER
```
  - RESIDUE_SERIAL
```
public static final AtomToken RESIDUE_SERIAL
```
  - RESIDUE_INSERTION
```
public static final AtomToken RESIDUE_INSERTION
```
  - X_COORDINATE
```
public static final AtomToken X_COORDINATE
```
  - Y_COORDINATE
```
public static final AtomToken Y_COORDINATE
```
  - Z_COORDINATE
```
public static final AtomToken Z_COORDINATE
```
  - OCCUPANCY
```
public static final AtomToken OCCUPANCY
```
  - TEMPERATURE_FACTOR
```
public static final AtomToken TEMPERATURE_FACTOR
```
  - ELEMENT_SYMBOL
```
public static final AtomToken ELEMENT_SYMBOL
```
  - ELEMENT_CHARGE
```
public static final AtomToken ELEMENT_CHARGE
```
- Field Detail
  - RECORD_PATTERN
```
public static final Pattern RECORD_PATTERN
```
- Method Detail
  - values
```
public static AtomToken[] 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 (AtomToken c : AtomToken.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AtomToken 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
  - assembleAtom
```
public static OakAtom assembleAtom(String atomLine)
```
  - assemblePDBLine
```
public static List<String> assemblePDBLine(LeafSubstructure leaf)
```
  - 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.
  - 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.

Enum AtomToken

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

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

Enum Constant Detail

RECORD_TYPE

ATOM_SERIAL

ATOM_NAME

ALTERNATE_LOCATION_INDICATOR

RESIDUE_NAME

CHAIN_IDENTIFIER

RESIDUE_SERIAL

RESIDUE_INSERTION

X_COORDINATE

Y_COORDINATE

Z_COORDINATE

OCCUPANCY

TEMPERATURE_FACTOR

ELEMENT_SYMBOL

ELEMENT_CHARGE

Field Detail

RECORD_PATTERN

Method Detail

values

valueOf

assembleAtom

assemblePDBLine

getColumns

getRecordNamePattern