Package org.rcsb.strucmotif.domain.align

Enum AtomPairingScheme

java.lang.Object

java.lang.Enum<AtomPairingScheme>

org.rcsb.strucmotif.domain.align.AtomPairingScheme

All Implemented Interfaces:

Serializable, Comparable<AtomPairingScheme>, java.lang.constant.Constable, Predicate<LabelAtomId>

public enum AtomPairingScheme
extends Enum<AtomPairingScheme>
implements Predicate<LabelAtomId>

Schemes on which atoms (by name) to use to align residues. Each entry is actually a Predicate which tests atom names and returns true if fall into that particular scheme.

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
ALL	Use everything.
ALPHA_CARBON	Use alpha carbons only.
BACKBONE	Use backbone atoms only.
BETA_CARBON	Use beta carbons only.
PSEUDO_ATOMS	Use pseudo-atoms defined by ResiduePairDescriptor.
SIDE_CHAIN	Use side-chain atoms only.

Method Summary

Modifier and Type	Method	Description
boolean	test(LabelAtomId s)
static AtomPairingScheme	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AtomPairingScheme[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Predicate

and, negate, or

Enum Constant Details

ALL

public static final AtomPairingScheme ALL

Use everything.

ALPHA_CARBON

public static final AtomPairingScheme ALPHA_CARBON

Use alpha carbons only.

BETA_CARBON

public static final AtomPairingScheme BETA_CARBON

Use beta carbons only.

BACKBONE

public static final AtomPairingScheme BACKBONE

Use backbone atoms only.

SIDE_CHAIN

public static final AtomPairingScheme SIDE_CHAIN

Use side-chain atoms only.

PSEUDO_ATOMS

public static final AtomPairingScheme PSEUDO_ATOMS

Use pseudo-atoms defined by ResiduePairDescriptor.

Method Details

values

public static AtomPairingScheme[] 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 AtomPairingScheme 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

test

public boolean test(LabelAtomId s)

Specified by:

test in interface Predicate<LabelAtomId>