org.proteinshader.structure.enums
Enum HelixShapeEnum

java.lang.Object
  java.lang.Enum<HelixShapeEnum>
      org.proteinshader.structure.enums.HelixShapeEnum

All Implemented Interfaces:

Serializable, Comparable<HelixShapeEnum>

public enum HelixShapeEnum
extends Enum<HelixShapeEnum>

Lists the possible shapes that can be used to represent a Helix.

Enum Constant Summary

ALPHA_RIBBON
The helix should be represented as a ribbon-like object.

ALPHA_TUBE
The helix should be represented as a spiral tube.

CYLINDER
The helix should be represented as a cylinder.

Method Summary

static HelixShapeEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static HelixShapeEnum[]	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

CYLINDER

public static final HelixShapeEnum CYLINDER

The helix should be represented as a cylinder.

ALPHA_RIBBON

public static final HelixShapeEnum ALPHA_RIBBON

The helix should be represented as a ribbon-like object.

ALPHA_TUBE

public static final HelixShapeEnum ALPHA_TUBE

The helix should be represented as a spiral tube.

Method Detail

values

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

Returns:

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

valueOf

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