edu.nrao.sss.util
Enum FileCompressionFormat

java.lang.Object
  java.lang.Enum<FileCompressionFormat>
      edu.nrao.sss.util.FileCompressionFormat

All Implemented Interfaces:

Serializable, Comparable<FileCompressionFormat>

public enum FileCompressionFormat
extends Enum<FileCompressionFormat>

An enumeration of file compression formats to be used by SourceCatalogReaders.

Enum Constant Summary

GZ

UNCOMPRESSED

ZIP

Method Summary

static FileCompressionFormat	fromString(String text) Returns the compression format represented by text.
String	toString() Returns a text representation of this file compression format.
static FileCompressionFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static FileCompressionFormat[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNCOMPRESSED

public static final FileCompressionFormat UNCOMPRESSED

ZIP

public static final FileCompressionFormat ZIP

GZ

public static final FileCompressionFormat GZ

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Returns a text representation of this file compression format.

Overrides:

toString in class Enum<FileCompressionFormat>

Returns:

a text representation of this file compression format.

fromString

public static FileCompressionFormat fromString(String text)

Returns the compression format represented by text.

For details about the transformation, see EnumerationUtility.enumFromString(Class, String).

Parameters:

text - a text representation of a file compression format.

Returns:

the file compression format represented by text.