org.proteinshader.structure.enums
Enum DrawableEnum

java.lang.Object
  extended by java.lang.Enum<DrawableEnum>
      extended by org.proteinshader.structure.enums.DrawableEnum
All Implemented Interfaces:
Serializable, Comparable<DrawableEnum>

public enum DrawableEnum
extends Enum<DrawableEnum>

Provides an enumeration to specify if a Drawable object is an Atom, Bond, or Segment.

This enumeration allows the Structure2Graphics class to use a simple switch statement to determine how to render a Drawable object.


Enum Constant Summary
ATOM
           
BOND
           
SEGMENT
           
 
Method Summary
static DrawableEnum valueOf(String name)
          Returns the enum constant of this type with the specified name.
static DrawableEnum[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ATOM

public static final DrawableEnum ATOM

BOND

public static final DrawableEnum BOND

SEGMENT

public static final DrawableEnum SEGMENT
Method Detail

values

public static final DrawableEnum[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(DrawableEnum c : DrawableEnum.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static DrawableEnum 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


Copyright © 2007-2008