net.sf.mmm.util.resource.impl

Class ClasspathScannerImpl.ClasspathFile

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

All Implemented Interfaces:

BrowsableResource, DataResource, ResourcePath

Enclosing class:

ClasspathScannerImpl

protected static class ClasspathScannerImpl.ClasspathFile
extends ClasspathScannerImpl.AbstractBrowsableClasspathResource

A file on the classpath. Like ClasspathResource but browsable.

Field Summary

Fields

Modifier and Type	Field and Description
private URL	url

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

Method Summary

Modifier and Type	Method and Description
Iterable<? extends ClasspathScannerImpl.AbstractBrowsableClasspathResource>	getChildResources() This method iterates the immediate child-resources contained in this BrowsableResource.
URL	getUrl() This method gets this resource as URL.
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.

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

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

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

url

private URL url

See Also:

getUrl()

Constructor Detail

ClasspathFile

public ClasspathFile(ClasspathScannerImpl.ClasspathFolder parent,
                     String name)

The constructor.

Parameters:

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

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

Method Detail

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.