com.levigo.jadice.format.text

Class TextFormat

java.lang.Object

com.levigo.jadice.document.Format

com.levigo.jadice.format.text.TextFormat

All Implemented Interfaces:

Cloneable

public class TextFormat
extends Format

Gain information about support for plain text data.

Field Summary

Fields inherited from class com.levigo.jadice.document.Format

BASE_FORMAT_VERSION, DEFAULT_PRIORITY, MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
TextFormat() Default constructor

Method Summary

Modifier and Type	Method and Description
Format	create(MimeType type) Create an instance of this format corresponding to the given MIME type.
FormatReader	createReader() Returns a file format corresponding file format to read the raw data stream and to create pages from the containing data.
String[]	getDefaultExtensions() Returns the default file extensions for this format
String	getDescription() Returns a description text for this format
MimeType	getMimeType() Return the string-encoded MIME-Type of the format.
String	getName() Returns a short description text for this format
int	getPriority() Return the priority with which this format will be selected, if there are multiple eligible ones.
String	getVersion() Returns the version of this format
boolean	matches(SeekableInputStream stream) Text formats always match a file.

Methods inherited from class com.levigo.jadice.document.Format

canRead, canWrite, createWriter, equals, hashCode, isSecondary, isSupported, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TextFormat

public TextFormat()

Default constructor

Method Detail

getDefaultExtensions

public String[] getDefaultExtensions()

Returns the default file extensions for this format

Specified by:

getDefaultExtensions in class Format

Returns:

String[] an array of file extension

getDescription

public String getDescription()

Returns a description text for this format

Specified by:

getDescription in class Format

Returns:

String format description

getName

public String getName()

Returns a short description text for this format

Specified by:

getName in class Format

Returns:

String short format description

getVersion

public final String getVersion()

Returns the version of this format

Specified by:

getVersion in class Format

Returns:

String format version

matches

public final boolean matches(SeekableInputStream stream)
                      throws IOException

Text formats always match a file.

Specified by:

matches in class Format

Parameters:

stream - contains the data to be tested.

Returns:

True if the data matches, otherwise false.

Throws:

IOException - if an io error occurs

See Also:

Format.matches(com.levigo.jadice.document.io.SeekableInputStream)

createReader

public final FormatReader createReader()

Returns a file format corresponding file format to read the raw data stream and to create pages from the containing data.

Overrides:

createReader in class Format

Returns:

AbstractFileFormat approbate file format

getPriority

public int getPriority()

Description copied from class: Format

Return the priority with which this format will be selected, if there are multiple eligible ones. Formats with lower priorities are tried after ones with higher values.

Overrides:

getPriority in class Format

Returns:

the priority

See Also:

Format.MIN_PRIORITY, Format.DEFAULT_PRIORITY, Format.MAX_PRIORITY

getMimeType

public MimeType getMimeType()

Description copied from class: Format

Return the string-encoded MIME-Type of the format.

Specified by:

getMimeType in class Format

Returns:

the MIME-Type

create

public Format create(MimeType type)

Description copied from class: Format

Create an instance of this format corresponding to the given MIME type. This operation may encompass configuring the format from the given type's parameters.

Overrides:

create in class Format

Parameters:

type - the MIME type

Returns:

an instance of this format corresponding to the given MIME type