org.biojava.bio.structure
Enum ElementType

java.lang.Object
  extended by java.lang.Enum<ElementType>
      extended by org.biojava.bio.structure.ElementType
All Implemented Interfaces:
Serializable, Comparable<ElementType>

public enum ElementType
extends Enum<ElementType>
implements Serializable

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

Enum Constant Summary
ACTINOID
           
ALKALI_METAL
           
ALKALINE_EARTH_METAL
           
HALOGEN
           
LANTHANOID
           
METALLOID
           
NOBLE_GAS
           
OTHER_NONMETAL
           
POST_TRANSITION_METAL
           
TRANSITION_METAL
           
UNKNOWN
           
 
Method Summary
 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

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 Detail

values

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

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.