net.sf.mmm.util.resource.base

Class AbstractBrowsableResourceFactory.BrowsableResourceAdapter

java.lang.Object

net.sf.mmm.util.resource.base.AbstractDataResourceProxy

net.sf.mmm.util.resource.base.AbstractBrowsableResourceProxy

net.sf.mmm.util.resource.base.AbstractBrowsableResourceFactory.BrowsableResourceAdapter

All Implemented Interfaces:

BrowsableResource, DataResource

Enclosing class:

AbstractBrowsableResourceFactory

protected class AbstractBrowsableResourceFactory.BrowsableResourceAdapter
extends AbstractBrowsableResourceProxy

This is an implementation of the BrowsableResource interface, that adapts another BrowsableResource and enhances the navigate(String)-method to support switching schemes via the BrowsableResourceFactory that created this BrowsableResource.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private BrowsableResource	delegate

Constructor Summary

Constructors

Constructor and Description
BrowsableResourceAdapter(BrowsableResource delegate) The constructor.

Method Summary

Modifier and Type	Method and Description
BrowsableResource	cd(String path) Changes the directory from this BrowsableResource to the given path.
protected BrowsableResource	getDelegate() This method gets the DataResource this proxy delegates to.
DataResource	navigate(String relativePath) This method retrieves a DataResource pointing to the given resourcePath based on this resource. E.g.

Methods inherited from class net.sf.mmm.util.resource.base.AbstractBrowsableResourceProxy

getChildResources, getChildResources, isFolder, openOutputStream

Methods inherited from class net.sf.mmm.util.resource.base.AbstractDataResourceProxy

getLastModificationDate, getName, getPath, getSize, getUri, getUrl, isAvailable, isData, isModifiedSince, openStream, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.resource.api.DataResource

getLastModificationDate, getName, getPath, getSize, getUri, getUrl, isAvailable, isData, isModifiedSince, openStream

Field Detail

delegate

private final BrowsableResource delegate

Constructor Detail

BrowsableResourceAdapter

public BrowsableResourceAdapter(BrowsableResource delegate)

The constructor.

Parameters:

delegate - is the BrowsableResource to adapt.

Method Detail

getDelegate

protected BrowsableResource getDelegate()

Description copied from class: AbstractDataResourceProxy

This method gets the DataResource this proxy delegates to.

Specified by:

getDelegate in class AbstractBrowsableResourceProxy

Returns:

the delegate.

navigate

public DataResource navigate(String relativePath)
                      throws ResourceUriUndefinedException

Description copied from interface: DataResource

This method retrieves a DataResource pointing to the given resourcePath based on this resource.
E.g. if this resource points to the file "/etc/init.d/rc" and resourcePath would be "../apt/sources.list" the resulting resource would point to "/etc/apt/sources.list".
ATTENTION:
As you can see by the example above this method always navigates relative to the parent folder of this resource. This will also be the case if this resource itself is a folder. Due to this generic API this is the only consistent way as there are implementations that can not easily know if they represent a folder or a file or maybe even both at the same time. However, please be aware of this and do not get confused as you might expect this to be a cd command if invoked on a folder what is not exactly not the case (instead it is a cd on the parent folder). On a BrowsableResource you can use BrowsableResource.cd(String) instead to avoid confusion.

Specified by:

navigate in interface DataResource

Overrides:

navigate in class AbstractDataResourceProxy

Parameters:

relativePath - the absolute or relative path pointing to a new resource. If it is a relative path, it is interpreted relative to the parent URI (directory) of this resource.

Returns:

the resource pointing to the given path (relative to this resource).

Throws:

ResourceUriUndefinedException - if the given resourcePath leads to an undefined or illegal URI.

See Also:

BrowsableResource.cd(String)

cd

public BrowsableResource cd(String path)

Description copied from interface: BrowsableResource

Changes the directory from this BrowsableResource to the given path.

Specified by:

cd in interface BrowsableResource

Overrides:

cd in class AbstractBrowsableResourceProxy

Parameters:

path - the absolute or relative path pointing to a new resource. If it is a relative path, it is interpreted relative to the current URI (directory) if this is a folder and relative to the parent URI otherwise.

Returns:

the resource pointing to the given path (relative to this resource).

See Also:

DataResource.navigate(String)