org.settings4j

Interface ContentResolver

All Known Implementing Classes:

ClasspathContentResolver, FilteredContentResolverWrapper, FSContentResolver, UnionContentResolver

public interface ContentResolver

a ContentResolver is a Helper for read/write byte[] content for a given key.

 Example configuration in settings4j.xml:
 --------------------------------------
 <contentResolver name="ClasspathContentResolver"
      class="org.settings4j.contentresolver.ClasspathContentResolver">
 </contentResolver>
 --------------------------------------
 

This is usefull for SystemPropertyConnector or PropertyFileConnector. If you define a ContentResolver in this Connectors, you can rever to a File of the FileSystem or Classpath.

 Example Connector usage in settings4j.xml:
 --------------------------------------
 <connector name="SystemPropertyConnector" class="org.settings4j.connector.SystemPropertyConnector" >
     <contentResolver-ref ref="ClasspathContentResolver" />
 </connector>
 --------------------------------------

 Example usage in java-code:

 --------------------------------------
 // alternativ start myapp with -Dxyz=com/mycompany/myapp/xyz-config.xml
 System.setProperty("xyz", "com/mycompany/myapp/xyz-config.xml"); //refer to the ClasspathContentResolver

 // somewhere in myapp:
 byte[] xyzConfig = Settings4j.getContent("xyz"); // get Classpath-URL from the SystemPropertyConnector
 --------------------------------------
 

Author:

Harald.Brabenetz

Method Summary

Modifier and Type	Method and Description
void	addContentResolver(ContentResolver contentResolver) Some Implementations of a ContentResolver are delegating the functionality to other ContentResolvers.
byte[]	getContent(String key) Reads the Content for the given Key or null if nothing where found.

Method Detail

getContent

byte[] getContent(String key)

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

Parameters:

key - The key

Returns:

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

addContentResolver

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>
 --------------------------------------
 

Parameters:

contentResolver - the original contentResolver to delegate.