net.pandoragames.far.ui.model

Class FileType

java.lang.Object

net.pandoragames.far.ui.model.FileType

Direct Known Subclasses:

MimeType

public class FileType
extends java.lang.Object

Binds certain properties, such as encoding, to a category of files.

Author:

Olivier Wehner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileType.BUILDIN The names of the build in file types.

Field Summary

Fields

Modifier and Type	Field and Description
static FileType	ARCHIVE Binary file type for archives such as zip and tar.gz.
static FileType	BINARY Ancestor of all binary file types.
static FileType	DOCUMENT File type for binary documents such as PDF, odf and docx.
static FileType	FILE The supertype of all file types.
protected static java.util.Map<java.lang.String,FileType>	fileTypes To be accessed by inheriting classes only.
static FileType	SGML SGML file types such as html.
static FileType	SOURCE Source code text files.
static FileType	TABLE Tabular text data such as tab and csv.
static FileType	TEXT Ancestor of all text file types.
static boolean	TREAT_UNKNOWN_AS_BINARY Should files of unknown mime type be treated as binary (or as plain text)?
static FileType	XML XML base type.

Constructor Summary

Constructors

Constructor and Description
FileType(java.lang.String name, FileType parent) Every file type has a name.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Two file types are considered equal if they have the same name.
java.nio.charset.Charset	getCharacterset() Returns the associated character set.
java.lang.String	getName() Returns the file type name.
FileType	getParentType() Returns the parent type.
static FileType	getType(java.lang.String name) Returns the specified type by name if it does exist.
int	hashCode() Hashcode for this FileType.
boolean	isBinary() Returns true if this Mime type denotes a binary file.
boolean	isCharsetDefined() Returns true if the character set associate with this file type is specifically defined for this file type.
boolean	isText() Returns true if this Mime type denotes a text file.
void	setCharacterset(java.nio.charset.Charset charset) Defines the character set for this file type or removes the definition (if the parameter is null).
void	setParentType(FileType newParent) Sets the specified FileType as new parent type of this type.
java.lang.String	toString() Returns "FileType:<Typ>".

Methods inherited from class java.lang.Object

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

Field Detail

TREAT_UNKNOWN_AS_BINARY

public static boolean TREAT_UNKNOWN_AS_BINARY

Should files of unknown mime type be treated as binary (or as plain text)?

fileTypes

protected static java.util.Map<java.lang.String,FileType> fileTypes

To be accessed by inheriting classes only.

FILE

public static final FileType FILE

The supertype of all file types. It's child types are TEXT and BINARY.

BINARY

public static final FileType BINARY

Ancestor of all binary file types.

ARCHIVE

public static final FileType ARCHIVE

Binary file type for archives such as zip and tar.gz.

DOCUMENT

public static final FileType DOCUMENT

File type for binary documents such as PDF, odf and docx.

TEXT

public static final FileType TEXT

Ancestor of all text file types.

TABLE

public static final FileType TABLE

Tabular text data such as tab and csv.

SOURCE

public static final FileType SOURCE

Source code text files.

SGML

public static final FileType SGML

SGML file types such as html.

XML

public static final FileType XML

XML base type.

Constructor Detail

FileType

public FileType(java.lang.String name,
        FileType parent)

Every file type has a name. If parent is not specified, the file type will be a child of the common super type (FILE).

Parameters:

name - file type name

parent - file type parent

Method Detail

getType

public static FileType getType(java.lang.String name)

Returns the specified type by name if it does exist. The file type name is case sensitive.

Parameters:

name - file type name to look up

Returns:

file type or null

getName

public java.lang.String getName()

Returns the file type name.

Returns:

file type name

getParentType

public FileType getParentType()

Returns the parent type.

Returns:

parent type

setParentType

public void setParentType(FileType newParent)

Sets the specified FileType as new parent type of this type. Checks for null and circular dependencies.

Parameters:

newParent - to be set, must not be null

Throws:

java.lang.NullPointerException - if specified parent is null

java.lang.IllegalArgumentException - if specified parent is a descendant of this FileType

getCharacterset

public java.nio.charset.Charset getCharacterset()

Returns the associated character set. If no character set has been associated with this file type, the character set of the parent type will be returned.

Returns:

associated character set

setCharacterset

public void setCharacterset(java.nio.charset.Charset charset)

Defines the character set for this file type or removes the definition (if the parameter is null).

Parameters:

charset - to be associated with this file type or null.

isCharsetDefined

public boolean isCharsetDefined()

Returns true if the character set associate with this file type is specifically defined for this file type. Returns false if this file type uses the character set of its parent.

Returns:

true if associated character set is defined on this file type

equals

public boolean equals(java.lang.Object o)

Two file types are considered equal if they have the same name.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Hashcode for this FileType.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Returns "FileType:<Typ>".

Overrides:

toString in class java.lang.Object

isBinary

public boolean isBinary()

Returns true if this Mime type denotes a binary file.

Returns:

true if binary file type

isText

public boolean isText()

Returns true if this Mime type denotes a text file.

Returns:

true if text file type