Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="695c65bd2bdbcef6-c768104b-4f294155-82b3a78d-6dbe69f0d7ffde0a838d4403"><ac:plain-text-body><![CDATA[

[http://jakarta.apache.org/commons/resources/ Home]

[wiki:Resources Wiki]

[wiki:ResourcesUserGuide Guide]

[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/ XREFSource]

]]></ac:plain-text-body></ac:structured-macro>

...

  • Wiki Markup
    \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/ResourcesBase.html ResourcesBase\] - implements Resources
    • void:init() - (optional) for initialization processing.
    • Iterator:getKeys() - (required) return the set (Iterator) of keys in this Resources
    • Object:getObject(key, Locale, TimeZone) - (required) retrieve the content for a key/Locale/Timezone
  • Wiki Markup
    \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/CollectionResourcesBase.html CollectionResourcesBase\] - extends *ResourcesBase* and provides a mechanism for caching a set of *Map*s containing key/value pairs for a Locale.
    • void:init() - (optional) for initialization processing.
    • Map:getLocaleMap(baseUrl, Locale) (required) returns a Map of key/value pairs for a Locale.

...

No Format
    public class MyResources extends ResourcesBase {

        private String config;

        public MyResources(String name, config) {
            super(name);
            this.config = config;
        }

        public void init() {
            // do initialization here, if required
        }

        public Iterator getKeys() {
            // must implement this method
        }

        public Object getObject(String key, Locale locale, TimeZone timeZone) {
            // must implement this method
        }

    }

4.2 CollectionsResourcesBase

...

Wiki Markup
To create a *factory* for your *Resources* implementation, extendsextend the \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/ResourcesFactoryBase.html ResourcesFactoryBase\] ...

...

Wiki Markup
*N.B* for implementations to be used in a Web Application there is a \[http://jakarta.apache.org/commons/resources/apidocs/org/apache/commons/resources/impl/WebappResourcesFactoryBase.html WebappResourcesFactoryBase\] factory which includes a *ServletContext* property with appropriate read/write methods.

...

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="69f69546eb8a7d96-801d6de9-41384d39-a00099b4-dee99382df4e6a35b73f3540"><ac:plain-text-body><![CDATA[

[http://jakarta.apache.org/commons/resources/ Home]

[wiki:Resources Wiki]

[wiki:ResourcesUserGuide Guide]

[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/ XREFSource]

]]></ac:plain-text-body></ac:structured-macro>