net.sf.mmm.util.path.base

Class AbstractPathFactory

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.util.path.base.AbstractPathFactory

All Implemented Interfaces:

PathFactory

Direct Known Subclasses:

PathFactoryImpl

public abstract class AbstractPathFactory
extends AbstractLoggableComponent
implements PathFactory

This is the abstract base implementation of the PathFactory interface.

Since:

5.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,PathProvider>	schema2providerMap

Fields inherited from interface net.sf.mmm.util.path.api.PathFactory

CDI_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractPathFactory() The constructor.

Method Summary

Modifier and Type	Method and Description
Path	createPath(Path basePath, String resourcePath) This method creates a new Path for the given parameters.
private Path	createPath(PathUri uri)
Path	createPath(String resourceUri) This method creates a new Path for the given resourceUri.
protected PathProvider	getProvider(PathUri pathUri) This method gets the PathProvider for the given PathUri.
void	registerProvider(PathProvider provider) This method registers the given PathProvider.
void	registerProvider(PathProvider provider, String schemePrefix) This method registers the given PathProvider.

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, doInitialize, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

schema2providerMap

private final Map<String,PathProvider> schema2providerMap

Constructor Detail

AbstractPathFactory

public AbstractPathFactory()

The constructor.

Method Detail

registerProvider

public void registerProvider(PathProvider provider)
                      throws DuplicateObjectException

This method registers the given PathProvider.

Parameters:

provider - is the PathProvider to register.

Throws:

DuplicateObjectException - if a PathProvider is already registered for one of the scheme-prefixes.

registerProvider

public void registerProvider(PathProvider provider,
                             String schemePrefix)
                      throws DuplicateObjectException

This method registers the given PathProvider.

Parameters:

provider - is the PathProvider to register.

schemePrefix - is the scheme-prefix for which the PathProvider shall be registered.

Throws:

DuplicateObjectException - if a PathProvider is already registered for one of the scheme-prefixes.

getProvider

protected PathProvider getProvider(PathUri pathUri)
                            throws ResourceUriUndefinedException

This method gets the PathProvider for the given PathUri.

Parameters:

pathUri - is the PathUri.

Returns:

the PathProvider responsible for the given PathUri .

Throws:

ResourceUriUndefinedException - if no provider is registered that is responsible.

createPath

public Path createPath(String resourceUri)

Description copied from interface: PathFactory

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/

Specified by:

createPath in interface PathFactory

Parameters:

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

Returns:

the requested Path.

createPath

private Path createPath(PathUri uri)

Parameters:

uri - is the PathUri.

Returns:

the according Path.

See Also:

createPath(String)

createPath

public Path createPath(Path basePath,
                       String resourcePath)

Description copied from interface: PathFactory

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.

Specified by:

createPath in interface PathFactory

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.