icy.file

Enum ImageFileFormat

java.lang.Object

java.lang.Enum<ImageFileFormat>

icy.file.ImageFileFormat

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ImageFileFormat>

public enum ImageFileFormat
extends java.lang.Enum<ImageFileFormat>

Define some default image file format for Icy.

Author:

Stephane

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVI
JPG
LSM
PNG
TIFF

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	canRead() Returns true if the image file format supports read operation.
abstract boolean	canWrite() Returns true if the image file format supports write operation.
java.lang.String	getDescription() Returns the image file format description.
loci.formats.gui.ExtensionFileFilter	getExtensionFileFilter() Returns the associated ExtensionFileFilter
java.lang.String[]	getExtensions() Returns the image file format extensions.
static ImageFileFormat	getFormat(FileFormat format) For backward compatibility with FileFormat.
static ImageFileFormat	getFormat(java.lang.String ext, ImageFileFormat defaultValue) Returns the FileFormat corresponding to specified extension.
static ImageFileFormat	getReadFormat(java.lang.String ext, ImageFileFormat defaultValue) Returns the ImageFileFormat corresponding to the specified extension and which support read operation.
static ImageFileFormat	getWriteFormat(java.lang.String ext, ImageFileFormat defaultValue) Returns the ImageFileFormat corresponding to the specified extension and which support write operation.
boolean	matches(java.lang.String ext) Return true if the specified extension matches this format.
abstract FileFormat	toFileFormat() For backward compatibility with FileFormat.
static ImageFileFormat	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ImageFileFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TIFF

public static final ImageFileFormat TIFF

PNG

public static final ImageFileFormat PNG

LSM

public static final ImageFileFormat LSM

JPG

public static final ImageFileFormat JPG

AVI

public static final ImageFileFormat AVI

Method Detail

values

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

Returns:

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

valueOf

public static ImageFileFormat valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

canRead

public abstract boolean canRead()

Returns true if the image file format supports read operation.

canWrite

public abstract boolean canWrite()

Returns true if the image file format supports write operation.

getDescription

public java.lang.String getDescription()

Returns the image file format description.

getExtensions

public java.lang.String[] getExtensions()

Returns the image file format extensions.

toFileFormat

public abstract FileFormat toFileFormat()

For backward compatibility with FileFormat.

getExtensionFileFilter

public loci.formats.gui.ExtensionFileFilter getExtensionFileFilter()

Returns the associated ExtensionFileFilter

matches

public boolean matches(java.lang.String ext)

Return true if the specified extension matches this format.
defaultValue is returned if no matching format is found (it can be null).

getFormat

public static ImageFileFormat getFormat(java.lang.String ext,
                        ImageFileFormat defaultValue)

Returns the FileFormat corresponding to specified extension.
defaultValue is returned if no matching format is found.

getReadFormat

public static ImageFileFormat getReadFormat(java.lang.String ext,
                            ImageFileFormat defaultValue)

Returns the ImageFileFormat corresponding to the specified extension and which support read operation.
defaultValue is returned if no matching format is found.

getWriteFormat

public static ImageFileFormat getWriteFormat(java.lang.String ext,
                             ImageFileFormat defaultValue)

Returns the ImageFileFormat corresponding to the specified extension and which support write operation.
defaultValue is returned if no matching format is found.

getFormat

public static ImageFileFormat getFormat(FileFormat format)

For backward compatibility with FileFormat.