de.bioforscher.singa.structure.model.oak

Enum StructuralEntityFilter.LeafFilterType

java.lang.Object

java.lang.Enum<StructuralEntityFilter.LeafFilterType>

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

All Implemented Interfaces:

Serializable, Comparable<StructuralEntityFilter.LeafFilterType>

Enclosing class:

StructuralEntityFilter

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

Simple StructuralEntityFilter.LeafFilter representation as functional Enum class.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AMINO_ACID
ATOM_CONTAINER
NUCLEOTIDE

Method Summary

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

AMINO_ACID

public static final StructuralEntityFilter.LeafFilterType AMINO_ACID

ATOM_CONTAINER

public static final StructuralEntityFilter.LeafFilterType ATOM_CONTAINER

NUCLEOTIDE

public static final StructuralEntityFilter.LeafFilterType NUCLEOTIDE

Method Detail

values

public static StructuralEntityFilter.LeafFilterType[] 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.LeafFilterType c : StructuralEntityFilter.LeafFilterType.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.LeafFilterType 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

getFilter

public Predicate<LeafSubstructure> getFilter()