org.settings4j.objectresolver

Class AbstractObjectResolver

java.lang.Object

org.settings4j.objectresolver.AbstractObjectResolver

All Implemented Interfaces:

ObjectResolver

Direct Known Subclasses:

JavaXMLBeansObjectResolver, SpringConfigObjectResolver

public abstract class AbstractObjectResolver
extends Object
implements ObjectResolver

Basic Connector implementations like getter and Setter of contentResolver, objectResolver.

Author:

Harald.Brabenetz

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_CACHED The Key if the found Object should be cached (this will handle the Object as singleton).
static String	PROP_OBJECT_RESOLVER_KEY The Key which ObjectResolver implementation should be used.

Constructor Summary

Constructors

Constructor and Description
AbstractObjectResolver()

Method Summary

Modifier and Type	Method and Description
void	addObjectResolver(ObjectResolver objectResolver) Some Implementations of a ObjectResolver are delegating the functionality to other ObjectResolvers.
protected abstract Object	contentToObject(String key, Properties properties, byte[] content, ContentResolver contentResolver) Method to convert the given content-File to an Object must be implemented by SubClasses.
Object	getObject(String key, ContentResolver contentResolver) Reads the byte[] content from the ContentResolver and creates an Object.
protected Properties	getObjectProperties(String key, ContentResolver contentResolver) To get the additional Properties for the given byte[] content can be overwriten by subclasses.
protected String	getObjectResolverKey()
String	getPropertySuffix()
boolean	isCached()
void	setCached(boolean cached)
void	setPropertySuffix(String propertySuffix)

Methods inherited from class java.lang.Object

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

Field Detail

PROP_OBJECT_RESOLVER_KEY

public static final String PROP_OBJECT_RESOLVER_KEY

The Key which ObjectResolver implementation should be used.

See Also:

Constant Field Values

PROP_CACHED

public static final String PROP_CACHED

The Key if the found Object should be cached (this will handle the Object as singleton).

See Also:

Constant Field Values

Constructor Detail

AbstractObjectResolver

public AbstractObjectResolver()

Method Detail

addObjectResolver

public void addObjectResolver(ObjectResolver objectResolver)

Description copied from interface: ObjectResolver

Some Implementations of a ObjectResolver are delegating the functionality to other ObjectResolvers.

Examples are: UnionObjectResolver

 --------------------------------------
 <objectResolver name="DefaultObjectResolver" class="org.settings4j.objectresolver.UnionObjectResolver">
     <objectResolver-ref ref="JavaXMLBeansObjectResolver" />
     <objectResolver-ref ref="SpringConfigObjectResolver" />
 </objectResolver>
 --------------------------------------
 

Specified by:

addObjectResolver in interface ObjectResolver

Parameters:

objectResolver - the original objectResolver to delegate.

getObject

public Object getObject(String key,
                        ContentResolver contentResolver)

Description copied from interface: ObjectResolver

Reads the byte[] content from the ContentResolver and creates an Object. The normal usecase of an implementation of this ObjectResolver Interface:

1. Read the Propertyfile from ContentResolver.getContent(key + ".properties")
2. Read the Value of "objectResolverKey" from propertyfile
3. The "objectResolverKey" defines which ObjectResolver-Implementation should solve the byte[] content to a Java-Object
4. Convert the byte[] from ContentResolver.getContent(String key) to an Object.
5. Maybe additional values are consumed from the propertyfile

Specified by:

getObject in interface ObjectResolver

Parameters:

key - The Key of the byte[] who should be converted to an Object.

contentResolver - The contentResolver, from where the content could be read.

Returns:

the Object, or null if this Object-Resolver can not convert the byte[] Content to an Object.

getObjectProperties

protected Properties getObjectProperties(String key,
                                         ContentResolver contentResolver)

To get the additional Properties for the given byte[] content can be overwriten by subclasses.

The default implementation reads the PropertyFile from key + ".properties". If no property where found, or an error occurs, this method return null.

Parameters:

key - the key of the byte[] Content to convert.

contentResolver - the ContentResolver to read the additional Property-File.

Returns:

the parsed Properties Object or null if an error occurred.

getPropertySuffix

public String getPropertySuffix()

setPropertySuffix

public void setPropertySuffix(String propertySuffix)

getObjectResolverKey

protected String getObjectResolverKey()

contentToObject

protected abstract Object contentToObject(String key,
                                          Properties properties,
                                          byte[] content,
                                          ContentResolver contentResolver)

Method to convert the given content-File to an Object must be implemented by SubClasses.

Parameters:

key - The Original Key of the Object

properties - The Property-File which where Found under key + ".properties"

content - The byte[] Content to convert.

contentResolver - the contentResolver to get possible additional content Files.

Returns:

the parsed Object from the byte[] Content.

isCached

public boolean isCached()

setCached

public void setCached(boolean cached)