Package de.xima.fc.workflow

Class WrappedResourceDescriptor

java.lang.Object

de.xima.fc.workflow.WrappedResourceDescriptor

All Implemented Interfaces:

IResourceDescriptor, Serializable

public final class WrappedResourceDescriptor
extends Object
implements IResourceDescriptor

Wraps an existing IResourceDescriptor with a different URI.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
WrappedResourceDescriptor(URI uri, IResourceDescriptor content)	Creates a wrapped descriptor that reads from another resource descriptor, but allows you to change the URI to a different URI.

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.interfaces.workflow.IResourceDescriptor

getCharset

Constructor Detail

WrappedResourceDescriptor

public WrappedResourceDescriptor(URI uri,
                                 IResourceDescriptor content)

Creates a wrapped descriptor that reads from another resource descriptor, but allows you to change the URI to a different URI.

Parameters:

uri - New URI to use.

content - Descriptor to which to delegate for reading the resource content.

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.

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