Package org.biojava.nbio.structure.xtal

Enum TransformType

java.lang.Object

java.lang.Enum<TransformType>

org.biojava.nbio.structure.xtal.TransformType

All Implemented Interfaces:

Serializable, Comparable<TransformType>

public enum TransformType
extends Enum<TransformType>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AU
CELLTRANSL
FOURBAR
FOURFOLD
FOURFOLDSCREW
GLIDE
ONEBAR
SIXBAR
SIXFOLD
SIXFOLDSCREW
THREEBAR
THREEFOLD
THREEFOLDSCREW
TWOBAR
TWOFOLD
TWOFOLDSCREW
XTALTRANSL

Method Summary

Modifier and Type	Method	Description
int	getFoldType()
int	getId()
String	getShortName()
boolean	isInfinite()	Tells whether the transform type produces infinite assemblies if interface happens between identical chains
boolean	isScrew()	Tells whether the transform type is a screw or glide plane
static TransformType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TransformType[]	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

AU

public static final TransformType AU

XTALTRANSL

public static final TransformType XTALTRANSL

CELLTRANSL

public static final TransformType CELLTRANSL

TWOFOLD

public static final TransformType TWOFOLD

TWOFOLDSCREW

public static final TransformType TWOFOLDSCREW

THREEFOLD

public static final TransformType THREEFOLD

THREEFOLDSCREW

public static final TransformType THREEFOLDSCREW

FOURFOLD

public static final TransformType FOURFOLD

FOURFOLDSCREW

public static final TransformType FOURFOLDSCREW

SIXFOLD

public static final TransformType SIXFOLD

SIXFOLDSCREW

public static final TransformType SIXFOLDSCREW

ONEBAR

public static final TransformType ONEBAR

TWOBAR

public static final TransformType TWOBAR

GLIDE

public static final TransformType GLIDE

THREEBAR

public static final TransformType THREEBAR

FOURBAR

public static final TransformType FOURBAR

SIXBAR

public static final TransformType SIXBAR

Method Detail

values

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

Returns:

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

valueOf

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

getId

public int getId()

getFoldType

public int getFoldType()

isScrew

public boolean isScrew()

Tells whether the transform type is a screw or glide plane

Returns:

isInfinite

public boolean isInfinite()

Tells whether the transform type produces infinite assemblies if interface happens between identical chains

Returns:

getShortName

public String getShortName()