net.sf.mmm.util.resource.impl

Class AbstractBrowsableClasspathResource

java.lang.Object

net.sf.mmm.util.resource.base.AbstractDataResource

net.sf.mmm.util.resource.base.AbstractBrowsableResource

net.sf.mmm.util.resource.impl.AbstractBrowsableClasspathResource

All Implemented Interfaces:

BrowsableResource, DataResource, ResourcePath

Direct Known Subclasses:

ClasspathFile, ClasspathFolder

abstract class AbstractBrowsableClasspathResource
extends AbstractBrowsableResource
implements ResourcePath

Abstract base implementation of BrowsableResource for ClasspathFile or ClasspathFolder.

Since:

7.3.0 (moved from 7.0.0)

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private static String	EXTENSION_CLASS
(package private) String	name
private ClasspathFolder	parent
private String	qualifiedName

Fields inherited from interface net.sf.mmm.util.resource.api.ResourcePath

HOME_PATH_CHAR, PATH_SEGMENT_CURRENT_DIRECTORY, PATH_SEGMENT_PARENT_DIRECTORY, PATH_SEGMENT_SEPARATOR, PATH_SEGMENT_SEPARATOR_CHAR, UNC_PATH_PREFIX, URL_SCHEME_AUTHORITY_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
AbstractBrowsableClasspathResource(ClasspathFolder parent, String name) The constructor.

Method Summary

Modifier and Type	Method and Description
abstract Iterable<? extends AbstractBrowsableClasspathResource>	getChildResources() This method iterates the immediate child-resources contained in this BrowsableResource.
Date	getLastModificationDate() This method gets the last modification date of the DataResource if available and supported.
String	getName() This method gets the name of the resource.
ClasspathFolder	getParent()
String	getPath() This method gets the path of this resource.
protected void	getPath(StringBuilder buffer)
(package private) String	getQualifiedName()
ClasspathFolder	getRoot()
String	getSchemePrefix() This method gets the scheme-prefix of absolute URIs for this type of DataResource.
String	getUri() This method gets a string identifying this DataResource.
protected void	init() Initializes this resource after it has been properly initialzed.
boolean	isAbsolute()
boolean	isRoot()
DataResource	navigate(String resourcePath) 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.AbstractBrowsableResource

getChildResources

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

equals, getSize, hashCode, isAvailable, isModifiedSince, openOutputStream, openStream, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

cd, isFolder

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

getSize, getUrl, isAvailable, isData, isModifiedSince, openOutputStream, openStream

Field Detail

EXTENSION_CLASS

private static final String EXTENSION_CLASS

See Also:

Constant Field Values

parent

private final ClasspathFolder parent

name

final String name

qualifiedName

private final String qualifiedName

Constructor Detail

AbstractBrowsableClasspathResource

AbstractBrowsableClasspathResource(ClasspathFolder parent,
                                   String name)

The constructor.

Parameters:

parent - - see getParent().

name - - see getName().

Method Detail

getName

public String getName()

Description copied from interface: DataResource

This method gets the name of the resource. It is analog to a filename.

Specified by:

getName in interface DataResource

Specified by:

getName in interface ResourcePath

Overrides:

getName in class AbstractDataResource

Returns:

the name of the resource.

getQualifiedName

String getQualifiedName()

Returns:

the qualified java name (package name or class name). Will be null for a ClasspathFile that does not point to a Class file (*.class).

getParent

public ClasspathFolder getParent()

Specified by:

getParent in interface ResourcePath

Returns:

the parent folder.

navigate

public DataResource navigate(String resourcePath)
                      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

Parameters:

resourcePath - 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)

getLastModificationDate

public Date getLastModificationDate()

Description copied from interface: DataResource

This method gets the last modification date of the DataResource if available and supported.

Specified by:

getLastModificationDate in interface DataResource

Returns:

the last modification Date or null if not available or supported.

getSchemePrefix

public String getSchemePrefix()

Description copied from class: AbstractDataResource

This method gets the scheme-prefix of absolute URIs for this type of DataResource. The scheme-prefix has the following form: <scheme> :<suffix> where <suffix> is the empty string or something like //.

Specified by:

getSchemePrefix in class AbstractDataResource

Returns:

the scheme-prefix of this resource.

getUri

public String getUri()

Description copied from interface: DataResource

This method gets a string identifying this DataResource. In most cases this will be the same as string-representation of the URL. However this method will not throw an exception.

Specified by:

getUri in interface DataResource

Overrides:

getUri in class AbstractDataResource

Returns:

the URI as string.

getRoot

public ClasspathFolder getRoot()

Specified by:

getRoot in interface ResourcePath

Returns:

the root ancestor of this ResourcePathNode.

isAbsolute

public boolean isAbsolute()

Specified by:

isAbsolute in interface ResourcePath

Returns:

true if this path is absolute, false if it is relative.

isRoot

public boolean isRoot()

Specified by:

isRoot in interface ResourcePath

Returns:

true if this is the root ResourcePathNode, false otherwise.

getPath

public String getPath()

Description copied from interface: DataResource

This method gets the path of this resource. Please note that the path is including the name of the resource.
ATTENTION:
The result of this method may differ to the path used in the URL when this resource has been created.

Specified by:

getPath in interface DataResource

Overrides:

getPath in class AbstractDataResource

Returns:

the path that was used to identify this resource when creating.

getPath

protected void getPath(StringBuilder buffer)

Parameters:

buffer - is the StringBuilder where to append the string representation to.

getChildResources

public abstract Iterable<? extends AbstractBrowsableClasspathResource> getChildResources()

Description copied from interface: BrowsableResource

This method iterates the immediate child-resources contained in this BrowsableResource.
If this is no folder, this method will always return an empty Iterable.

Specified by:

getChildResources in interface BrowsableResource

Returns:

an Iterable of the child-resources.

init

protected void init()

Initializes this resource after it has been properly initialzed.