org.ginsim.common.utils

Class FileFormatDescription

java.lang.Object

org.ginsim.common.utils.FileFormatDescription

Direct Known Subclasses:

GenericDocumentFormat

public class FileFormatDescription
extends Object

Simple description of a file format. Each format has an identifier and an extension. A list of defined format is automatically maintained and can be used to retrieve a format by ID or by extension. "Groups" of related formats can also be created by subclassing (the class will be used as group identifier).

Author:

Aurelien Naldi

Field Summary

Fields

Modifier and Type	Field and Description
String	extension
String	id

Constructor Summary

Constructors

Constructor and Description
FileFormatDescription(String id, String extension)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static <C extends FileFormatDescription> C	getFormat(Class<C> cl, String id) Retrieve a subclassing format by ID.
static FileFormatDescription	getFormat(String id) Retrieve a format by id.
static <C extends FileFormatDescription> Collection<C>	getFormats(Class<C> cl) Retrieve all formats of a given subclass.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

id

public final String id

extension

public final String extension

Constructor Detail

FileFormatDescription

public FileFormatDescription(String id,
                             String extension)

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getFormat

public static FileFormatDescription getFormat(String id)

Retrieve a format by id.

Parameters:

id - a format identifier

Returns:

the Format corresponding to this identifier

getFormat

public static <C extends FileFormatDescription> C getFormat(Class<C> cl,
                                                            String id)

Retrieve a subclassing format by ID.

Parameters:

cl -

id -

Returns:

the corresponding format

getFormats

public static <C extends FileFormatDescription> Collection<C> getFormats(Class<C> cl)

Retrieve all formats of a given subclass.

Parameters:

cl -

Returns:

the list of matching formats