Resources User Guide

Novemeber 2005 This is a first stab at creating a basic User Guide for Commons Resources - feel free to correct, enhance and expand, niallp.

Commons Resources Overview

The core of the resources framework are two interfaces:

• [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/Resources.html Resources] Representation of a set of internationalized resources, which are arbitrary objects identified by a unique String key and can be accessed for different{{java.util.Locale}} and java.util.TimeZone.

• [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/ResourcesFactory.html ResourcesFactory] Factory class to configure and instantiate an appropriate Resources instance.
  

Basic imlementations of the above are provided for resources contained in property files, XML and databases(via JDBC). Implementations are also provided for use in a Web App environment.

The resources framework also includes interfaces for encapsualting messages and message lists:

• [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/Message.html Message] An encapsulation of an individual messag, consisting of a message key, and replacement values.

• [http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/MessageList.html MessageList] A class that encapsulates a set of messages.
  

Rest of the User Guide

The rest of the user guide is in the following sections, which are also available from the Navigation Bar at the top and bottom of each page:

1. [wiki:ResourcesUserGuideIntro Getting Started] - Using Resources 2. [wiki:ResourcesUserGuideMessages Messages] - Using Message and MessageList 3. [wiki:ResourcesUserGuideImplementations Standard] - Standard Resources Implementations 4. [wiki:ResourcesUserGuideCreating Creating] - Creating a Resources Implementation
   

You can also view the Javadoc and Source code using the links below (or on the Navigation Bar)
5. [http://jakarta.apache.org/commons/resources/apidocs/ API] - Javadocs
6. [http://jakarta.apache.org/commons/resources/xref/ Source] - Source Code XREF