net.sf.mmm.util.path.api

Interface PathFactory

All Known Implementing Classes:

AbstractPathFactory, PathFactoryImpl

@ComponentSpecification
public interface PathFactory

This is the interface for a factory used to create instance of Path across multiple FileSystems.
If you want to read resources from configurable locations, you should use this factory. In situations where you want to load a resource, for which you already know the location (e.g. from a specific classpath location) and you are going to wire the location into your code, you can bypass this factory and simply create a new instance of the according Path directly (e.g. Paths.get(java.net.URI)).

Since:

5.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Paths.get(java.net.URI)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CDI_NAME The CDI name.

Method Summary

Modifier and Type	Method and Description
Path	createPath(Path basePath, String resourcePath) This method creates a new Path for the given parameters.
Path	createPath(String resourceUri) This method creates a new Path for the given resourceUri.

Field Detail

CDI_NAME

static final String CDI_NAME

The CDI name.

See Also:

Constant Field Values

Method Detail

createPath

Path createPath(String resourceUri)

This method creates a new Path for the given resourceUri. The following URI-schemes are guaranteed to be supported:

scheme	example URI
file	file:///tmp/foo.xml
classpath	classpath:net/sf/mmm/util/beans-core.xml
http	http://m-m-m.sourceforge.net/maven/
https	https://github.com/m-m-m/mmm/

Parameters:

resourceUri - is the absolute URI pointing to the location of the requested Path.

Returns:

the requested Path.

createPath

Path createPath(Path basePath,
                String resourcePath)

This method creates a new Path for the given parameters. If the given resourcePath is absolute (including scheme), then this method returns the same result as createPath(resourcePath). Otherwise the resource path will be treated relative to the given basePath.

Parameters:

basePath - is the Path to use if resourcePath is relative. You typically want to provide the parent directory of a resource to navigate from.

resourcePath - is the absolute or relative path to the requested resource.

Returns:

the new path.