sbrt.shell.io
Class FileFormat

java.lang.Object
  extended by sbrt.shell.io.FileFormat

public class FileFormat
extends java.lang.Object

This class is used to represent file formats. A file format is a particular way to encode information for storage in a computer file.

Instances of this class are immutable.

Author:
This class was written and documented by Jeremiah Wright while in the Wagner lab.

Field Summary
static FileFormat GZIP_SER
          Used to denote a file containing serialized objects that has been compressed using the GNU program gzip.
static FileFormat GZIP_TEXT
          Used to denote a plain-text file that has been compressed using the GNU program gzip.
static FileFormat SERIALIZED
          Used to denote a file containing serialized objects.
static FileFormat TEXT
          Used to denote a plain-text file.
 
Method Summary
 java.lang.String getName()
          Returns the name of this file format.
 java.lang.String toString()
          Returns a string representation of this file format.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TEXT

public static final FileFormat TEXT
Used to denote a plain-text file.


GZIP_TEXT

public static final FileFormat GZIP_TEXT
Used to denote a plain-text file that has been compressed using the GNU program gzip.


SERIALIZED

public static final FileFormat SERIALIZED
Used to denote a file containing serialized objects.


GZIP_SER

public static final FileFormat GZIP_SER
Used to denote a file containing serialized objects that has been compressed using the GNU program gzip.

Method Detail

getName

public java.lang.String getName()
Returns the name of this file format.

Returns:
the name of this file format.

toString

public java.lang.String toString()
Returns a string representation of this file format.

Overrides:
toString in class java.lang.Object
Returns:
a string representation of this file format.