Package com.aquima.interactions.foundation.io.resource

Class ResourceDelegate

java.lang.Object

com.aquima.interactions.foundation.io.resource.ResourceDelegate

All Implemented Interfaces:

IResource

Direct Known Subclasses:

TextResource

public abstract class ResourceDelegate
extends Object
implements IResource

Resource delegete class for easy class delegation.

Since:

7.2

Author:

Jon van Leuven

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ResourceDelegate(IResource resource)

Method Summary

Modifier and Type	Method	Description
InputStream	asInputStream()	This method returns an input stream for the resource.
OutputStream	asOutputStream(boolean append)	This method returns an output stream that may be used to write the contents of the resource.
Reader	asReader()	This method returns a reader for the resource.
Writer	asWriter(boolean append)	This method returns a writer that may be used to write the contents of the resource.
boolean	createFile()	This method may be used to create the resource.
boolean	createFolder()	This method may be used to create the resource as folder.
protected IResource	getDelegate()
IResourceInfo	getInfo()	This method returns an object containing information about the resource.
IResource	getRelative(String relativePath)	This method can be used to retrieve a resource relative to the current resource from the same resource manager.

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceDelegate

protected ResourceDelegate(IResource resource)

Method Details

getDelegate

protected IResource getDelegate()

asInputStream

public InputStream asInputStream()

Description copied from interface: IResource

This method returns an input stream for the resource. The method will fail with an exception when the resource does not exist. The returned input stream should be closed by the invoking method.

Specified by:

asInputStream in interface IResource

Returns:

Input stream that can be used to read the contents of the resource.

asOutputStream

public OutputStream asOutputStream(boolean append)

Description copied from interface: IResource

This method returns an output stream that may be used to write the contents of the resource. The append parameter may be used to specify if data written to the output stream should be appended to the resource (true) or if the resource should be overwritten by the data added to the output stream (false).

Specified by:

asOutputStream in interface IResource

Parameters:

append - Boolean indicating if the data added to the output stream should be appended to the resource.

Returns:

Output stream that may be used to write the contents of the resource.

asReader

public Reader asReader()

Description copied from interface: IResource

This method returns a reader for the resource. The method will fail with an exception when the resource does not exist. The returned reader should be closed by the invoking method.

Specified by:

asReader in interface IResource

Returns:

Reader that can be used to read the contents of the resource.

asWriter

public Writer asWriter(boolean append)

Description copied from interface: IResource

This method returns a writer that may be used to write the contents of the resource. The append parameter may be used to specify if data written to the writer should be appended to the resource (true) or if the resource should be overwritten by the data added to the writer (false).

Specified by:

asWriter in interface IResource

Parameters:

append - Boolean indicating if the data added to the writer should be appended to the resource.

Returns:

Writer that may be used to write the contents of the resource.

createFile

public boolean createFile()

Description copied from interface: IResource

This method may be used to create the resource. This method is only applicable for resources that have been requested through the getRelative method, and that do not yet exist. The method returns a boolean indicating if the resource was actually created. When this method is invoked on a resource from a read only resource manager, an exception is thrown.

Specified by:

createFile in interface IResource

Returns:

boolean indicating if the resource was actually created.

createFolder

public boolean createFolder()

Description copied from interface: IResource

This method may be used to create the resource as folder. This method is only applicable for resources that have been requested through the getRelative method, and that do not yet exist. The method returns a boolean indicating if the resource folder was actually created. When this method is invoked on a resource from a read only resource manager, an exception is thrown.

Specified by:

createFolder in interface IResource

Returns:

boolean indicating if the resource folder was actually created.

getInfo

public IResourceInfo getInfo()

Description copied from interface: IResource

This method returns an object containing information about the resource. The information object may be used to determine if the resource actually exists, if it is read only, etc...

Specified by:

getInfo in interface IResource

Returns:

Object containing information about the resource.

getRelative

public IResource getRelative(String relativePath)

Description copied from interface: IResource

This method can be used to retrieve a resource relative to the current resource from the same resource manager. The returned resource may not yet exist. This method is only supported for resources of the type 'folder'.

Specified by:

getRelative in interface IResource

Parameters:

relativePath - relative path to current protocol and location

Returns:

A resource object