DsspType (mmtf-serialization 1.0.9 API)

java.lang.Object
- java.lang.Enum<DsspType>
- - org.rcsb.mmtf.dataholders.DsspType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DsspType>
```
public enum DsspType
extends java.lang.Enum<DsspType>
implements java.io.Serializable
```
The encoding of secondary structure types. Based on DSSP: Kabsch W, Sander C (1983). "Dictionary of protein secondary structure: pattern recognition of hydrogen-bonded and geometrical features". Biopolymers 22 (12): 2577–637. doi:10.1002/bip.360221211. PMID 6667333.

Author:

Anthony Bradley

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALPHA_HELIX` An alpha helix.
`BEND` A bend
`BRIDGE` A bridge.
`COIL` A coil.
`EXTENDED` An extended loop.
`HELIX_3_10` A 3-10 alpha helix.
`NULL_ENTRY` A null entry - or an entry not recognised.
`PI_HELIX` A pi helix.
`TURN` A turn.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DsspType`	`dsspTypeFromInt(int dsspType)` Creates a new DsspType from an int val Returns DsspType.NULL_ENTRY if dsspType is -1 or not one of the supported standard types.
`static DsspType`	`dsspTypeFromString(java.lang.String dsspType)` Creates a new DsspType from a String value.
`int`	`getDsspIndex()` Returns the index of the Dssp as an integer
`java.lang.String`	`getDsspType()` Returns the type of the DSSP as a String
`static DsspType`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static DsspType[]`	`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

- Enum Constant Detail
  - PI_HELIX
```
public static final DsspType PI_HELIX
```
    A pi helix.
  - BEND
```
public static final DsspType BEND
```
    A bend
  - ALPHA_HELIX
```
public static final DsspType ALPHA_HELIX
```
    An alpha helix.
  - EXTENDED
```
public static final DsspType EXTENDED
```
    An extended loop.
  - HELIX_3_10
```
public static final DsspType HELIX_3_10
```
    A 3-10 alpha helix.
  - BRIDGE
```
public static final DsspType BRIDGE
```
    A bridge.
  - TURN
```
public static final DsspType TURN
```
    A turn.
  - COIL
```
public static final DsspType COIL
```
    A coil.
  - NULL_ENTRY
```
public static final DsspType NULL_ENTRY
```
    A null entry - or an entry not recognised.
- Method Detail
  - values
```
public static DsspType[] 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 (DsspType c : DsspType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DsspType valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getDsspType
```
public java.lang.String getDsspType()
```
    Returns the type of the DSSP as a String
    
    Returns:
    
    String representation of the DSSP type.
  - getDsspIndex
```
public int getDsspIndex()
```
    Returns the index of the Dssp as an integer
    
    Returns:
    
    String representation of the Dssp type.
  - dsspTypeFromString
```
public static DsspType dsspTypeFromString(java.lang.String dsspType)
```
    Creates a new DsspType from a String value. Returns DsspType.NULL_ENTRY if dsspType is "NA" or not one of the supported standard types.
    
    Parameters:
    
    dsspType - String value , should be one of "pi Helix","Bend","alpha Helix","Extended", "3-10 Helix","Bridge","Turn","Coil","NA"
    
    Returns:
    
    an DsspType object
  - dsspTypeFromInt
```
public static DsspType dsspTypeFromInt(int dsspType)
```
    Creates a new DsspType from an int val Returns DsspType.NULL_ENTRY if dsspType is -1 or not one of the supported standard types.
    
    Parameters:
    
    dsspType - int value , should be an integer value from -1 to 7
    
    Returns:
    
    an DsspType object

Enum DsspType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

PI_HELIX

BEND

ALPHA_HELIX

EXTENDED

HELIX_3_10

BRIDGE

TURN

COIL

NULL_ENTRY

Method Detail

values

valueOf

getDsspType

getDsspIndex

dsspTypeFromString

dsspTypeFromInt