de.bioforscher.singa.structure.model.oak

Enum StructuralEntityFilter.AtomFilterType

java.lang.Object

java.lang.Enum<StructuralEntityFilter.AtomFilterType>

de.bioforscher.singa.structure.model.oak.StructuralEntityFilter.AtomFilterType

All Implemented Interfaces:

Serializable, Comparable<StructuralEntityFilter.AtomFilterType>

Enclosing class:

StructuralEntityFilter

public static enum StructuralEntityFilter.AtomFilterType
extends Enum<StructuralEntityFilter.AtomFilterType>

Simple StructuralEntityFilter.AtomFilter representation as functional Enum class.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALPHA_CARBON
ARBITRARY
BACKBONE
BACKBONE_CARBON
BACKBONE_NITROGEN
BACKBONE_OXYGEN
BETA_CARBON
CARBON
HYDROGEN
NITROGEN
OXYGEN
PHOSPHORUS
SIDE_CHAIN

Method Summary

Modifier and Type	Method and Description
String	getDescription()
Predicate<Atom>	getFilter()
static StructuralEntityFilter.AtomFilterType	valueOf(String name) Returns the enum constant of this type with the specified name.
static StructuralEntityFilter.AtomFilterType[]	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

ALPHA_CARBON

public static final StructuralEntityFilter.AtomFilterType ALPHA_CARBON

ARBITRARY

public static final StructuralEntityFilter.AtomFilterType ARBITRARY

BACKBONE

public static final StructuralEntityFilter.AtomFilterType BACKBONE

BACKBONE_CARBON

public static final StructuralEntityFilter.AtomFilterType BACKBONE_CARBON

BACKBONE_NITROGEN

public static final StructuralEntityFilter.AtomFilterType BACKBONE_NITROGEN

BACKBONE_OXYGEN

public static final StructuralEntityFilter.AtomFilterType BACKBONE_OXYGEN

BETA_CARBON

public static final StructuralEntityFilter.AtomFilterType BETA_CARBON

CARBON

public static final StructuralEntityFilter.AtomFilterType CARBON

HYDROGEN

public static final StructuralEntityFilter.AtomFilterType HYDROGEN

NITROGEN

public static final StructuralEntityFilter.AtomFilterType NITROGEN

OXYGEN

public static final StructuralEntityFilter.AtomFilterType OXYGEN

PHOSPHORUS

public static final StructuralEntityFilter.AtomFilterType PHOSPHORUS

SIDE_CHAIN

public static final StructuralEntityFilter.AtomFilterType SIDE_CHAIN

Method Detail

values

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

Returns:

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

valueOf

public static StructuralEntityFilter.AtomFilterType 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

getDescription

public String getDescription()

getFilter

public Predicate<Atom> getFilter()