org.settings4j.connector

Class ClasspathConnector

java.lang.Object

org.settings4j.connector.AbstractConnector

org.settings4j.connector.ClasspathConnector

All Implemented Interfaces:

Connector

public class ClasspathConnector
extends AbstractConnector

Connector implementation to read Settings from the Classpath.

Default Charset "UTF-8" is used to read the content from Classpath.

Author:

Harald.Brabenetz

Constructor Summary

Constructors

Modifier	Constructor and Description
	ClasspathConnector() Default Constructor (e.g. use in settings4j.xml).
protected	ClasspathConnector(ClasspathContentResolver classpathContentResolver) protected Constructor for extensions and Unit-Tests.

Method Summary

Modifier and Type	Method and Description
String	getCharset()
byte[]	getContent(String key) return a byte[]-Value for the given key or null if no file-content for the key where found.
protected ContentResolver	getContentResolver()
Object	getObject(String key) return a Object-Value for the given key.
String	getString(String key) return a String-Value for the given key.
void	setCharset(String charset)
void	setContentResolver(ContentResolver contentResolver) set a ContentResolver as Helper for Connector.getContent(String).

Methods inherited from class org.settings4j.connector.AbstractConnector

addConnector, getConnectors, getName, getObjectResolver, init, setName, setObjectResolver

Methods inherited from class java.lang.Object

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

Constructor Detail

ClasspathConnector

public ClasspathConnector()

Default Constructor (e.g. use in settings4j.xml).

ClasspathConnector

protected ClasspathConnector(ClasspathContentResolver classpathContentResolver)

protected Constructor for extensions and Unit-Tests.

Parameters:

classpathContentResolver - ClasspathContentResolver

Method Detail

getContent

public byte[] getContent(String key)

Description copied from interface: Connector

return a byte[]-Value for the given key or null if no file-content for the key where found.

The concrete implementation can use the ContentResolver if required

Parameters:

key - the Key for the configuration-property. e.g.: "com/mycompany/myapp/myParameterKey"

Returns:

the byte[]-Value for the given key

getObject

public Object getObject(String key)

Description copied from interface: Connector

return a Object-Value for the given key.

The concrete implementation can use the ObjectResolver if required

Parameters:

key - the Key for the configuration-property. e.g.: "com/mycompany/myapp/myParameterKey"

Returns:

the Object-Value for the given key, or null if no value where found.

getString

public String getString(String key)

Description copied from interface: Connector

return a String-Value for the given key.

Parameters:

key - the Key for the configuration-property. e.g.: "com/mycompany/myapp/myParameterKey"

Returns:

the String-Value for the given key

getCharset

public String getCharset()

setCharset

public void setCharset(String charset)

Parameters:

charset - a valid Charset

See Also:

Charset.isSupported(String)

setContentResolver

public void setContentResolver(ContentResolver contentResolver)

Description copied from interface: Connector

set a ContentResolver as Helper for Connector.getContent(String).

Specified by:

setContentResolver in interface Connector

Overrides:

setContentResolver in class AbstractConnector

Parameters:

contentResolver - the ContentResolver to set.

getContentResolver

protected ContentResolver getContentResolver()

Overrides:

getContentResolver in class AbstractConnector