com.lf.commons.model

Class ResourceFile

java.lang.Object

com.lf.commons.model.ResourceFile

Direct Known Subclasses:

ConfigFile, TextFile

public abstract class ResourceFile
extends java.lang.Object

Resource file base implementation.

Since:

1.6

Version:

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

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	comment The optional comment.
protected java.lang.String	id The identifier for the resource file.
protected java.lang.String	path The desired configuration path.
protected javax.activation.MimeType	type The optional MIME type of the resource file.

Constructor Summary

Constructors

Constructor and Description
ResourceFile() Constructor method for i18n purposes only.
ResourceFile(java.lang.String id, javax.activation.MimeType type, java.lang.String comment, java.lang.String path) Constructs a text file resource.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getComment() Provides the optional comment for the resource file helping the wetware.
java.lang.String	getDesiredPath() Provides the relative path used for the configuration directory like "/cache/file1.txt".
java.lang.String	getIdentifier() Provides the resource file identifier like "com/lf/commons/file1.txt".
javax.activation.MimeType	getMimeType() Provides the optional MIME type for the resource like "text/plain".

Methods inherited from class java.lang.Object

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

Field Detail

id

protected java.lang.String id

The identifier for the resource file.

type

protected javax.activation.MimeType type

The optional MIME type of the resource file.

comment

protected java.lang.String comment

The optional comment.

path

protected java.lang.String path

The desired configuration path.

Constructor Detail

ResourceFile

public ResourceFile()
             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

ResourceFile

public ResourceFile(java.lang.String id,
            javax.activation.MimeType type,
            java.lang.String comment,
            java.lang.String path)

Constructs a text file resource.

Parameters:

id - The identifier for the resource file

type - The MIME type of the file

comment - The optional comment

path - The desired configuration path

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

Method Detail

getIdentifier

public java.lang.String getIdentifier()

Provides the resource file identifier like "com/lf/commons/file1.txt".

In order to avoid that the same identifier is used by multiple resource files the identifiers should consist of full package and name. Remember that this identifier is not the name and path the resource is stored within the configuration directory. The desired path is provided by the getDesiredPath() method but it must not necessarily be used by the application model.

Returns:

The short resource name

Since:

1.6

getMimeType

public javax.activation.MimeType getMimeType()

Provides the optional MIME type for the resource like "text/plain".

Returns:

The MIME type (optional)

Since:

1.6

getComment

public java.lang.String getComment()

Provides the optional comment for the resource file helping the wetware.

Normally the comment should be returned in the current user locale.

Returns:

The resource comment (optional)

Since:

1.6

getDesiredPath

public java.lang.String getDesiredPath()

Provides the relative path used for the configuration directory like "/cache/file1.txt".

The desired path must not necessarily be the used by the model since another resource with the same desired path could have been registered successfully before. Use slashes as directory separators only. The leading slash can be omitted.

Returns:

The relative path

Since:

1.6