Package net.sf.mmm.util.resource.api

Provides the API for utilities that help to load resources from arbitrary sources.

See: Description

Interface Summary

Interface	Description
BrowsableResource	This is the interface for a DataResource that has higher-level features and may contain other resources.
BrowsableResourceFactory	This is the interface for a factory used to create instances of BrowsableResource.
ClasspathScanner	This is the interface for a component that scans the classpath for resources.
DataResource	This is the interface for a resource potentially containing data.
DataResourceFactory	This is the interface for a factory used to create DataResources.
ResourcePath	This class represents a path in a file, URL, or the like.
ResourceUri	This interface represents an URI pointing to the location of a DataResource.

Class Summary

Class	Description
ResourcePathNode<D>	This class represents a path in a file, URL, or the like.
ResourcePathNode.ResourcePathRootAbsolute<D>	Implementation of Unix/Linux absolute root.
ResourcePathNode.ResourcePathRootHome<D>	Implementation of home absolute root (~ or ~login).
ResourcePathNode.ResourcePathRootRelative<D>	Implementation of relative root.
ResourcePathNode.ResourcePathRootUnc<D>	Implementation of UNC absolute root.
ResourcePathNode.ResourcePathRootUrl<D>	Implementation of Unix/Linux absolute root.
ResourcePathNode.ResourcePathRootWindows<D>	Implementation of Windows absolute root drive.

Exception Summary

Exception	Description
ResourceNotAvailableException	This exception is thrown if a resource was requested that is NOT available.
ResourceNotWritableException	This exception is thrown if a resource should be written that is read-only or NOT writable for any other reason.
ResourceUriUndefinedException	This exception is thrown if a resource was requested for an URI that is undefined or illegal (e.g.

Package net.sf.mmm.util.resource.api Description

Provides the API for utilities that help to load resources from arbitrary sources.

Util Resource API

A DataResource represents a source of data. Unlike a File it abstracts from the underlying source that can be the regular filesystem (see FileResource), as well as the classpath (see ClasspathResource) the network (see UrlResource), etc.
The DataResourceFactory allows to create DataResources from any URI given as string (e.g. configured by the end-user).