Package org.biojava.nbio.structure.xtal

Enum BravaisLattice

java.lang.Object

java.lang.Enum<BravaisLattice>

org.biojava.nbio.structure.xtal.BravaisLattice

All Implemented Interfaces:

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

public enum BravaisLattice
extends Enum<BravaisLattice>

An enum to represent the 7 Bravais lattices

Author:

duarte_j

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
CUBIC
HEXAGONAL
MONOCLINIC
ORTHORHOMBIC
TETRAGONAL
TRICLINIC
TRIGONAL

Method Summary

Modifier and Type	Method	Description
static BravaisLattice	getByName(String blName)
CrystalCell	getExampleUnitCell()
int	getId()
String	getName()
static BravaisLattice	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BravaisLattice[]	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

TRICLINIC

public static final BravaisLattice TRICLINIC

MONOCLINIC

public static final BravaisLattice MONOCLINIC

ORTHORHOMBIC

public static final BravaisLattice ORTHORHOMBIC

TETRAGONAL

public static final BravaisLattice TETRAGONAL

TRIGONAL

public static final BravaisLattice TRIGONAL

HEXAGONAL

public static final BravaisLattice HEXAGONAL

CUBIC

public static final BravaisLattice CUBIC

Method Details

values

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

getName

public String getName()

getId

public int getId()

getExampleUnitCell

public CrystalCell getExampleUnitCell()

getByName

public static BravaisLattice getByName(String blName)