Package org.biojava.nbio.structure

Enum ElementType

java.lang.Object

java.lang.Enum<ElementType>

org.biojava.nbio.structure.ElementType

All Implemented Interfaces:

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

public enum ElementType
extends Enum<ElementType>

ElementType is an enumeration of the types of elements found in the periodic table. Each element type is further classified into Metal, Metalloid, and Non-Metal. Element types based on definition at http://www.ptable.com/

Since:

3.0

Version:

%I% %G%

Author:

Peter Rose

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
ACTINOID
ALKALI_METAL
ALKALINE_EARTH_METAL
HALOGEN
LANTHANOID
METALLOID
NOBLE_GAS
OTHER_NONMETAL
POST_TRANSITION_METAL
TRANSITION_METAL
UNKNOWN

Method Summary

Modifier and Type	Method	Description
boolean	isMetal()	Returns true if ElementType is a metal.
boolean	isMetalloid()	Returns true if ElementType is a metalloid.
boolean	isNonMetal()	Returns true if ElementType is a non-metal.
static ElementType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ElementType[]	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

Enum Constant Details

METALLOID

public static final ElementType METALLOID

OTHER_NONMETAL

public static final ElementType OTHER_NONMETAL

HALOGEN

public static final ElementType HALOGEN

NOBLE_GAS

public static final ElementType NOBLE_GAS

ALKALI_METAL

public static final ElementType ALKALI_METAL

ALKALINE_EARTH_METAL

public static final ElementType ALKALINE_EARTH_METAL

LANTHANOID

public static final ElementType LANTHANOID

ACTINOID

public static final ElementType ACTINOID

TRANSITION_METAL

public static final ElementType TRANSITION_METAL

POST_TRANSITION_METAL

public static final ElementType POST_TRANSITION_METAL

UNKNOWN

public static final ElementType UNKNOWN

Method Details

values

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

isMetal

public boolean isMetal()

Returns true if ElementType is a metal.

Returns:

true if ElementType is a metal.

isMetalloid

public boolean isMetalloid()

Returns true if ElementType is a metalloid.

Returns:

true if ElementType is a metalloid.

isNonMetal

public boolean isNonMetal()

Returns true if ElementType is a non-metal.

Returns:

true if ElementType is a non-metal.