Package de.xima.fc.workflow

Class DevResourceDescriptor

java.lang.Object

de.xima.fc.workflow.DevResourceDescriptor

All Implemented Interfaces:

IResourceDescriptor, Serializable

Direct Known Subclasses:

DevResourceDescriptor

public class DevResourceDescriptor
extends Object
implements IResourceDescriptor

Wraps a resource and serves it directly from the file system when dev mode is turned on.

Since:

7.0.10

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DevResourceDescriptor(String devPath, IResourceDescriptor fallback)	Creates a new resource descriptor for the given dev path, falling back to the (usual non-dev resource) when the file at the dev path does not exist.
DevResourceDescriptor(String basePath, String devPath, IResourceDescriptor fallback)	Creates a new resource descriptor for the given dev path, falling back to the (usual non-dev resource) when the file at the dev path does not exist.

Method Summary

Modifier and Type	Method	Description
URI	getAbsoluteUri()	Gets the absolute URI that identifies this resource.
Charset	getCharset()
InputStream	open()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DevResourceDescriptor

public DevResourceDescriptor(String devPath,
                             IResourceDescriptor fallback)
                      throws URISyntaxException

Creates a new resource descriptor for the given dev path, falling back to the (usual non-dev resource) when the file at the dev path does not exist.

Parameters:

devPath - URI to the development resource.

fallback - Fallback resource to use when dev resource is not available.

Throws:

URISyntaxException - When the fallback does not contain a valid URI.

DevResourceDescriptor

public DevResourceDescriptor(String basePath,
                             String devPath,
                             IResourceDescriptor fallback)
                      throws URISyntaxException

Creates a new resource descriptor for the given dev path, falling back to the (usual non-dev resource) when the file at the dev path does not exist.

Parameters:

basePath - Base path relative to which to interpret the devPath. When null or empty, uses the system base path of the local formcycle repository.

devPath - URI to the development resource.

fallback - Fallback resource to use when dev resource is not available.

Throws:

URISyntaxException - When the fallback does not contain a valid URI.

Method Detail

getAbsoluteUri

public URI getAbsoluteUri()

Description copied from interface: IResourceDescriptor

Gets the absolute URI that identifies this resource. The URI should be unique for each resource. If there are different versions of the same resource, they should have different URIs, e.g. by including a version number in the URI. The URI is not used to access the binary data, but may be used e.g. for caching purposes.

The URI must be unique globally, i.e. also across different plugins. It is recommended to use a URI scheme that is unlikely to be used by other plugins, e.g. by including the Maven group and artifact ID.

It is an error for this method to return a URI where URI.isAbsolute() yields false.

Specified by:

getAbsoluteUri in interface IResourceDescriptor

Returns:

An absolute URI that identifies this resource.

getCharset

public Charset getCharset()

Specified by:

getCharset in interface IResourceDescriptor

Returns:

When this resource is a plain text resource: the charset or encoding of the text. Defaults to UTF_8.

open

public InputStream open()
                 throws IOException

Specified by:

open in interface IResourceDescriptor

Returns:

An input stream to the content of the resource.

Throws:

IOException - When the resource could not be opened.

toString

public String toString()

Overrides:

toString in class Object