net.sf.mmm.util.resource.impl

Class ClasspathScannerImpl.ClasspathFolder

java.lang.Object

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

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

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

net.sf.mmm.util.resource.impl.ClasspathScannerImpl.ClasspathFolder

All Implemented Interfaces:

BrowsableResource, DataResource, ResourcePath

Enclosing class:

ClasspathScannerImpl

protected static class ClasspathScannerImpl.ClasspathFolder
extends ClasspathScannerImpl.AbstractBrowsableClasspathResource

A folder (package) of the classpath.

Field Summary

Fields

Modifier and Type	Field and Description
private List<ClasspathScannerImpl.AbstractBrowsableClasspathResource>	children

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
ClasspathFolder(ClasspathScannerImpl.ClasspathFolder parent, String name) The constructor.

Method Summary

Modifier and Type	Method and Description
ClasspathScannerImpl.AbstractBrowsableClasspathResource	getChildResource(String name)
Iterable<? extends ClasspathScannerImpl.AbstractBrowsableClasspathResource>	getChildResources() This method iterates the immediate child-resources contained in this BrowsableResource.
ClasspathScannerImpl.ClasspathFolder	getOrCreateChildFolder(String name)
URL	getUrl() This method gets this resource as URL.
protected void	init() Initializes this resource after it has been properly completed.
boolean	isData() This method determines if this resource has potentially data available.
boolean	isFolder() This method determines if this BrowsableResource is a folder that potentially contains other resources.
ClasspathScannerImpl.AbstractBrowsableClasspathResource	navigate(ResourcePathNode<Void> path)
DataResource	navigate(String resourcePath) This method retrieves a DataResource pointing to the given resourcePath based on this resource. E.g.
DataResource	navigate(String resourcePath, boolean returnNullIfNotExists)

Methods inherited from class net.sf.mmm.util.resource.impl.ClasspathScannerImpl.AbstractBrowsableClasspathResource

getLastModificationDate, getName, getParent, getPath, getPath, getRoot, getSchemePrefix, getUri, isAbsolute, isRoot

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.DataResource

getSize, isAvailable, isModifiedSince, openOutputStream, openStream

Field Detail

children

private List<ClasspathScannerImpl.AbstractBrowsableClasspathResource> children

See Also:

getChildResources()

Constructor Detail

ClasspathFolder

public ClasspathFolder(ClasspathScannerImpl.ClasspathFolder parent,
                       String name)

The constructor.

Parameters:

parent - - see ClasspathScannerImpl.AbstractBrowsableClasspathResource.getParent().

name - - see ClasspathScannerImpl.AbstractBrowsableClasspathResource.getName().

Method Detail

init

protected void init()

Initializes this resource after it has been properly completed.

Overrides:

init in class ClasspathScannerImpl.AbstractBrowsableClasspathResource

getChildResource

public ClasspathScannerImpl.AbstractBrowsableClasspathResource getChildResource(String name)

Parameters:

name - is the name of the requested child folder.

Returns:

the existing child folder or a new one created and added otherwise.

getOrCreateChildFolder

public ClasspathScannerImpl.ClasspathFolder getOrCreateChildFolder(String name)

Parameters:

name - is the name of the requested child folder.

Returns:

the existing child folder or a new one created and added otherwise.

getChildResources

public Iterable<? extends ClasspathScannerImpl.AbstractBrowsableClasspathResource> getChildResources()

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

Specified by:

getChildResources in class ClasspathScannerImpl.AbstractBrowsableClasspathResource

Returns:

an Iterable of the child-resources.

isFolder

public boolean isFolder()

This method determines if this BrowsableResource is a folder that potentially contains other resources. Otherwise if this is no folder, BrowsableResource.getChildResources() will be empty (return an empty Iterable). However BrowsableResource.getChildResources() can also be empty, if this is a folder.
In order to determine if this BrowsableResource is containing data, please use DataResource.isAvailable(). Please note that BrowsableResource.isFolder() and DataResource.isAvailable() can both return true or both return false.

Returns:

true if this is a folder, false otherwise.

isData

public boolean isData()

This method determines if this resource has potentially data available. Unlike DataResource.isAvailable() this method will not invoke expensive operations like connecting to remote URLs. If this method will return false, then DataResource.isAvailable() would also have returned false. However in case of true only DataResource.isAvailable() can guarantee if a resource really exists and contains data. E.g. if the resource points to a File then this method can check if it is a data-file. So in case it points to a directory or does not exist at all in the filesystem, this method will return false. Please also note that this may invoke expensive operations if the according directory path points to something like a network share. You should also be aware that the state of DataResource.isData() and DataResource.isAvailable() can change at any time so you never have a full guarantee if some data exists or NOT. However in most cases it is very improbable that this status changes when you read the resource immediately after the check.

Returns:

true if this resource points to potential data, false otherwise.

getUrl

public URL getUrl()
           throws ResourceNotAvailableException

This method gets this resource as URL.

Returns:

the URL that represents this resource.

Throws:

ResourceNotAvailableException - if an URL can NOT be created because the represented resource does not exist.

navigate

public ClasspathScannerImpl.AbstractBrowsableClasspathResource navigate(ResourcePathNode<Void> path)

Parameters:

path - the ResourcePathNode.

Returns:

the ClasspathScannerImpl.AbstractBrowsableClasspathResource.

See Also:

navigate(String)

navigate

public DataResource navigate(String resourcePath)
                      throws ResourceUriUndefinedException

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

Specified by:

navigate in interface DataResource

Overrides:

navigate in class ClasspathScannerImpl.AbstractBrowsableClasspathResource

Parameters:

resourcePath - is 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:

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

Throws:

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

navigate

public DataResource navigate(String resourcePath,
                             boolean returnNullIfNotExists)

Parameters:

resourcePath - the path to navigate to.

returnNullIfNotExists - - if true then null is returned for non-existent resources, otherwise a ClasspathResource is created and returned.

Returns:

the requested DataResource.

See Also:

navigate(ResourcePathNode)