org.settings4j

Interface ObjectResolver

All Known Implementing Classes:

AbstractObjectResolver, FilteredObjectResolverWrapper, JavaXMLBeansObjectResolver, SpringConfigObjectResolver, UnionObjectResolver

public interface ObjectResolver

The ObjectResolver is a Helper to resolve byte[] Content to a Java Object.

 Example Configuration in settings4j.xml:
 

 <connector name="ClasspathConnector"
          class="org.settings4j.connector.ClasspathConnector">
     <objectResolver-ref ref="JavaXMLBeansObjectResolver" />
 </connector>
 <objectResolver name="JavaXMLBeansObjectResolver"
          class="org.settings4j.objectresolver.JavaXMLBeansObjectResolver" />
 

You can now store a XMLEncoded (Serialized) Java-Objects into your Classpath.
see JavaXMLBeansObjectResolver for more details.
Or see SpringConfigObjectResolver for more details on a Spring Configuration File to generate an Object. Requires Springframework (tested with 2.5.6)

Author:

Harald.Brabenetz

Method Summary

Methods

Modifier and Type	Method and Description
void	addObjectResolver(ObjectResolver objectResolver) Some Implementations of a ObjectResolver are delegating the functionality to other ObjectResolvers.
Object	getObject(String key, ContentResolver contentResolver) Reads the byte[] content from the ContentResolver and creates an Object.

Method Detail

getObject

Object getObject(String key,
               ContentResolver contentResolver)

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

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.

addObjectResolver

void addObjectResolver(ObjectResolver 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>
 --------------------------------------
 

Parameters:

objectResolver - the original objectResolver to delegate.