Package org.rcsb.cif

Enum CifOptions.CifOptionsBuilder.FileFormat

java.lang.Object

java.lang.Enum<CifOptions.CifOptionsBuilder.FileFormat>

org.rcsb.cif.CifOptions.CifOptionsBuilder.FileFormat

All Implemented Interfaces:

Serializable, Comparable<CifOptions.CifOptionsBuilder.FileFormat>

Enclosing class:

CifOptions.CifOptionsBuilder

public static enum CifOptions.CifOptionsBuilder.FileFormat
extends Enum<CifOptions.CifOptionsBuilder.FileFormat>

Supported file formats.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BCIF_GZIPPED	.bcif.gz
BCIF_PLAIN	.bcif
CIF_GZIPPED	.cif.gz
CIF_PLAIN	.cif

Method Summary

Modifier and Type	Method	Description
static CifOptions.CifOptionsBuilder.FileFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CifOptions.CifOptionsBuilder.FileFormat[]	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

BCIF_PLAIN

public static final CifOptions.CifOptionsBuilder.FileFormat BCIF_PLAIN

.bcif

BCIF_GZIPPED

public static final CifOptions.CifOptionsBuilder.FileFormat BCIF_GZIPPED

.bcif.gz

CIF_PLAIN

public static final CifOptions.CifOptionsBuilder.FileFormat CIF_PLAIN

.cif

CIF_GZIPPED

public static final CifOptions.CifOptionsBuilder.FileFormat CIF_GZIPPED

.cif.gz

Method Detail

values

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

Returns:

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

valueOf

public static CifOptions.CifOptionsBuilder.FileFormat 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