org.settings4j.contentresolver

Class ClasspathContentResolver

java.lang.Object

org.settings4j.contentresolver.ClasspathContentResolver

All Implemented Interfaces:

ContentResolver

public class ClasspathContentResolver
extends Object
implements ContentResolver

ContentResolver implementation to read content from the Classpath.

Uses the default ClassLoader: typically the thread context ClassLoader see getClassLoader().

Optional Path Prefix is "classpath:".

Author:

Harald.Brabenetz

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASSPATH_URL_PREFIX Pseudo URL prefix for loading from the class path: "classpath:".

Constructor Summary

Constructors

Constructor and Description
ClasspathContentResolver()

Method Summary

Methods

Modifier and Type	Method and Description
void	addContentResolver(ContentResolver contentResolver) Some Implementations of a ContentResolver are delegating the functionality to other ContentResolvers.
static ClassLoader	getClassLoader() Return the default ClassLoader to use: typically the thread context ClassLoader, if available; the ClassLoader that loaded the ClasspathContentResolver class will be used as fallback.
byte[]	getContent(String key) Reads the Content for the given Key or null if nothing where found.
static URL	getResource(String key) Method to get onlx the URL for the given Key.

Methods inherited from class java.lang.Object

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

Field Detail

CLASSPATH_URL_PREFIX

public static final String CLASSPATH_URL_PREFIX

Pseudo URL prefix for loading from the class path: "classpath:".

See Also:

Constant Field Values

Constructor Detail

ClasspathContentResolver

public ClasspathContentResolver()

Method Detail

addContentResolver

public void addContentResolver(ContentResolver contentResolver)

Some Implementations of a ContentResolver are delegating the functionality to other ContentResolvers.
Examples are: UnionContentResolver

 --------------------------------------
 <contentResolver name="DefaultContentResolver" class="org.settings4j.contentresolver.UnionContentResolver">
     <contentResolver-ref ref="FSContentResolver" />
     <contentResolver-ref ref="ClasspathContentResolver" />
 </contentResolver>
 --------------------------------------
 

Specified by:

addContentResolver in interface ContentResolver

Parameters:

contentResolver - the original contentResolver to delegate.

getContent

public byte[] getContent(String key)

Reads the Content for the given Key or null if nothing where found.

Specified by:

getContent in interface ContentResolver

Parameters:

key - The key

Returns:

The byte[] Content or null if nothing where found.

getResource

public static URL getResource(String key)

Method to get onlx the URL for the given Key.

Parameters:

key - the key (could have a 'classpath:' prefix or not)

Returns:

The URL, see ClassLoader.getResource(String).

getClassLoader

public static ClassLoader getClassLoader()

Return the default ClassLoader to use: typically the thread context ClassLoader, if available; the ClassLoader that loaded the ClasspathContentResolver class will be used as fallback.

Call this method if you intend to use the thread context ClassLoader in a scenario where you absolutely need a non-null ClassLoader reference: for example, for class path resource loading (but not necessarily for Class.forName, which accepts a null ClassLoader reference as well).

Returns:

the default ClassLoader (never null)

See Also:

Thread.getContextClassLoader()