org.settings4j.connector

Class FSConnector

java.lang.Object

org.settings4j.connector.AbstractConnector

org.settings4j.connector.FSConnector

All Implemented Interfaces:

Connector

public class FSConnector
extends AbstractConnector

The FileSystem implementation of an Connector.

Author:

Harald.Brabenetz

Constructor Summary

Constructors

Modifier	Constructor and Description
	FSConnector() Default Constructor (e.g. use in settings4j.xml).
protected	FSConnector(FSContentResolver fsContentResolver) 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.
File	getRootFolder() return the root of this FileSystem ContenResolver.
String	getString(String key) return a String-Value for the given key.
void	setCharset(String charset)
void	setContent(String key, byte[] value)
void	setContentResolver(ContentResolver contentResolver) set a ContentResolver as Helper for Connector.getContent(String).
void	setRootFolderPath(String rootFolderPath) Delegate the rootFolderPath to the FSContentResolver.setRootFolderPath(String).
void	setString(String key, String value)

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

FSConnector

public FSConnector()

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

FSConnector

protected FSConnector(FSContentResolver fsContentResolver)

protected Constructor for extensions and Unit-Tests.

Parameters:

fsContentResolver - FSContentResolver

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

setContent

public void setContent(String key,
                       byte[] value)
                throws IOException

Parameters:

key - The Settings4j Key.

value - The value to Store.

Throws:

IOException - if an error occured.

setString

public void setString(String key,
                      String value)
               throws IOException

Parameters:

key - The Settings4j Key.

value - The value to Store.

Throws:

IOException - if an error occured.

getCharset

public String getCharset()

setCharset

public void setCharset(String charset)

Parameters:

charset - a valid Charset

See Also:

Charset.isSupported(String)

setRootFolderPath

public void setRootFolderPath(String rootFolderPath)

Delegate the rootFolderPath to the FSContentResolver.setRootFolderPath(String).

Parameters:

rootFolderPath - The root Folder Path where the settings could be stored.

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

getRootFolder

public File getRootFolder()

return the root of this FileSystem ContenResolver.

if no one is set, the "." will be returned.

Returns:

the root of this FileSystem ContenResolver.