io.devcon5.classutils

Class ResourceResolver

java.lang.Object

io.devcon5.classutils.ResourceResolver

public class ResourceResolver
extends Object

A resolver to locate resources on the local classpath. Created by Gerald Muecke on 24.11.2015.

Constructor Summary

Constructors

Constructor and Description
ResourceResolver() Creates a new ResourceResolver that doesn't fail if the resource is missing.
ResourceResolver(boolean failOnMissingResource) Creates a new ResourceResolver that will fail with an AssertionError if the resource can not be located.

Method Summary

Modifier and Type	Method and Description
URL	resolve(String resource) Resolves a URL of the resource specified.
URL	resolve(String resource, Class consumer) Resolves a URL of the resource specified using the provided class as hint to start the search.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceResolver

public ResourceResolver()

Creates a new ResourceResolver that doesn't fail if the resource is missing.

ResourceResolver

public ResourceResolver(boolean failOnMissingResource)

Creates a new ResourceResolver that will fail with an AssertionError if the resource can not be located.

Parameters:

failOnMissingResource - set to true if an exception should be thrown in case the resource is not found

Method Detail

resolve

public URL resolve(String resource)

Resolves a URL of the resource specified. The resource path should be absolute, as there is no hint provided, where to start the search. The resource is looked up using either the context classloader or the classloader of the resolver itself.

Parameters:

resource - the resource to be resolved

Returns:

the URL of the resource or null if it wasnt found.

Throws:

AssertionError - If the resolver is configured to fail on missing resource

resolve

public URL resolve(String resource,
                   Class consumer)

Resolves a URL of the resource specified using the provided class as hint to start the search. For searching the resource the consumer's classloader is used.

Parameters:

resource - the path the resource. The path can be either absolute or relative to the consumers location.

consumer - the consumer class of the resource. It's classloader is used for the lookup and it's location is used as reference point for resolving relative path names

Returns:

a URL to the resolved resource