<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6ff5a60450218b13-6030ea04-4c2848f8-b97a9d57-f00948c3bfc5a9481e069af4"><ac:plain-text-body><![CDATA[ | [http://jakarta.apache.org/commons/resources/ Home] | [wiki:Resources Wiki] | [wiki:ResourcesUserGuide ContentsGuide] | [wiki:ResourcesUserGuideIntro Getting Started] | [wiki:ResourcesUserGuideMessages Messages] | [wiki:ResourcesUserGuideImplementations Standard] | [wiki:ResourcesUserGuideCreating Creating] | [http://jakarta.apache.org/commons/resources/apidocs/ API] | [http://jakarta.apache.org/commons/resources/xref/ XREF] | ]]></ac:plain-text-body></ac:structured-macro> |
...
1. Getting Started
1.1
...
TO DO put something here
1.2 Using Resources
TO DO put something here
1.3 Return Null?
Using Resources
Wiki Markup |
---|
The first thing is to get hold of / create a \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/ResourcesFactory.html ResourcesFactory\] for the *Resources* implementation you want to use... |
No Format |
---|
ResourcesFactory factory = new PropertyResourcesFactory();
factory.setReturnNull(true);
|
N.B. See below for an explantion of the return null configuration option.
Then you can get a Resources instance (the factory may either create a new instance or provide a cached instance, depending on its implementation)...
No Format |
---|
Resources resources = factory.getResources("Bar", "file:c:/myapp/foo/Bar");
|
Once you have the resources instance, you can then use it to retrieve localized resources using one of the five content retrieval methods provided...
No Format |
---|
Object resource = resources.getObject("foo.key", locale, null);
String resource = resources.getString("foo.key", locale, null);
byte[] resource = resources.getBytes("foo.key", locale, null);
Reader resource = resources.getReader("foo.key", locale, null);
InputStream resource = resources.getInputStream("foo.key", locale, null);
|
1.1.1 Return Null Option
Wiki Markup |
---|
The *return null* configuration option indicates what the above five _content retrieval_ methods should do when a resource key is not found - they _either_ return a *{{null}}* value or throw a \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/ResourcesKeyException.html ResourcesKeyException\]. |
Use the factory's write method for that property to configure your Resources instances for this option:
No Format |
---|
factory.setReturnNull(true);
|
1.1.2 Resources Implementations
OK the next question is what Resources implementation do I use? You have two choices...
Wiki Markup \[wiki:ResourcesUserGuideImplementations Standard Implementations\] - Commons Resources comes with a set of standard implementations for *properties* files, *XML* documents, *database* resources and versions for use in a *Web Application*
Wiki Markup \[wiki:ResourcesUserGuideCreating Creating an Implementation\] - create your own implementation. \\
1.2 Messages
The majority of what Commons Resources is about centers around the Resources type. However there are also two types defined for handling messages:
Wiki Markup \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/Message.html Message\] - a message representation.
Wiki Markup \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/MessageList.html MessageList\] - a set of Message objects. \\
There is also a convenience class, provding static methods to facilitate handling messages:
Wiki Markup \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/Messages.html Messages\] - convenience class for handling messages. \\ \\
Wiki Markup |
---|
See the \[wiki:ResourcesUserGuideMessages Messages\] section in this User Guide for more details. |
...
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9be1d904b6151575-612cab7d-4bbe4a73-a249a509-a67cdc39f86850e6cb902a5e"><ac:plain-text-body><![CDATA[ | [http://jakarta.apache.org/commons/resources/ Home] | [wiki:Resources Wiki] | [wiki:ResourcesUserGuide GuideResourcesUserGuide Contents] | [wiki:ResourcesUserGuideIntro Getting Started] | [wiki:ResourcesUserGuideMessages Messages] | [wiki:ResourcesUserGuideImplementations Standard] | [wiki:ResourcesUserGuideCreating Creating] | [http://jakarta.apache.org/commons/resources/apidocs/ API] | [http://jakarta.apache.org/commons/resources/xref/ XREF] | ]]></ac:plain-text-body></ac:structured-macro> |