Package org.biojava.nbio.structure.secstruc

Enum BridgeType

java.lang.Object

java.lang.Enum<BridgeType>

org.biojava.nbio.structure.secstruc.BridgeType

All Implemented Interfaces:

Serializable, Comparable<BridgeType>, java.lang.constant.Constable

public enum BridgeType
extends Enum<BridgeType>

A bridge is formed by two non-overlapping stretches of three residues each (i-1,i,i+1) and (j-1,j,j+1), where i<j.

Depending on two basic patterns, a Bridge can be either of type parallel (H bonds in {(i-1,j) and (j,i+1)} OR {(j-1,i) and (i,j-1)}) or antiparallel (H bonds in {(i1,j) and (j,i} OR {(i-1,j+1) and (j-1,i+1)})

Author:

Andreas Prlic, Aleix Lafita

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
antiparallel
parallel

Field Summary

Fields

Modifier and Type	Field	Description
final String	name
final Character	type

Method Summary

Modifier and Type	Method	Description
static BridgeType	fromCharacter(Character stype)
String	toString()
static BridgeType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BridgeType[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

parallel

public static final BridgeType parallel

antiparallel

public static final BridgeType antiparallel

Field Details

type

public final Character type

name

public final String name

Method Details

values

public static BridgeType[] values()

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

Returns:

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

valueOf

public static BridgeType 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

fromCharacter

public static BridgeType fromCharacter(Character stype)

toString

public String toString()

Overrides:

toString in class Enum<BridgeType>