com.lf.commons.model.file

Class TextFile

java.lang.Object

com.lf.commons.model.ResourceFile

com.lf.commons.model.file.TextFile

public class TextFile
extends ResourceFile

Resource file implementation wrapping files with MIME type "text/plain".

Since:

1.6

Version:

$Revision: 1.8 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields inherited from class com.lf.commons.model.ResourceFile

comment, id, path, type

Constructor Summary

Constructors

Constructor and Description
TextFile() Constructor method for i18n purposes only.
TextFile(java.lang.String id, java.lang.String comment, java.lang.String path) Constructs a text file resource.

Method Summary

Methods

Modifier and Type	Method and Description
void	deserialize(java.io.InputStream istream, java.lang.String format) Reads the resource contents from the specified stream.
void	serialize(java.io.OutputStream ostream, java.lang.String format) Saves the resource contents persistently with the specified byte based output stream.

Methods inherited from class com.lf.commons.model.ResourceFile

getComment, getDesiredPath, getIdentifier, getMimeType

Methods inherited from class java.lang.Object

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

Constructor Detail

TextFile

public TextFile()
         throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

TextFile

public TextFile(java.lang.String id,
        java.lang.String comment,
        java.lang.String path)

Constructs a text file resource.

Parameters:

id - The identifier for the resource file

comment - The optional comment

path - The desired configuration path

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

Method Detail

serialize

public void serialize(java.io.OutputStream ostream,
             java.lang.String format)
               throws java.io.IOException

Saves the resource contents persistently with the specified byte based output stream.

Parameters:

ostream - Byte based output stream with a certain encoding

format - The format the data is stored (FORMAT_UNCOMPRESSED|...)

Throws:

java.io.IOException - An I/O error occurred

Since:

1.6

deserialize

public void deserialize(java.io.InputStream istream,
               java.lang.String format)
                 throws java.io.IOException

Reads the resource contents from the specified stream.

Parameters:

istream - The byte based stream to be read from, never closed

format - The format the data is stored (FORMAT_UNCOMPRESSED|...)

Throws:

java.io.IOException - An I/O error occurred

Since:

1.5