Package org.opencms.i18n

Class CmsVfsResourceBundle

java.lang.Object

java.util.ResourceBundle

org.opencms.i18n.CmsVfsResourceBundle

All Implemented Interfaces:

I_CmsResourceBundle

public class CmsVfsResourceBundle
extends ResourceBundle
implements I_CmsResourceBundle

Resource bundle which loads its data from a VFS resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CmsVfsResourceBundle.I_Loader	Implementors of this interface are responsible for actually loading the data from the VFS.

Nested classes/interfaces inherited from class java.util.ResourceBundle

ResourceBundle.Control

Field Summary

Fields

Modifier and Type	Field	Description
protected static CmsObject	m_cms	The CMS context to use.
protected CmsVfsResourceBundle.I_Loader	m_loader	The bundle loader instance to use.
protected CmsVfsBundleParameters	m_parameters	The VFS bundle parameters.
static final String	TYPE_PROPERTIES	Name constant for the 'properties' vfs bundle type.
static final String	TYPE_XML	Name constant for the 'xml content' vfs bundle type.

Fields inherited from class java.util.ResourceBundle

parent

Constructor Summary

Constructors

Constructor	Description
CmsVfsResourceBundle(CmsVfsBundleParameters params)	Creates a new VFS bundle instance.

Method Summary

Modifier and Type	Method	Description
CmsVfsResourceBundle	getClone()	Creates a clone of the resource bundle.
protected String	getFilePath()	Returns the path of the file to read the message data from.
Enumeration<String>	getKeys()
Locale	getLocale()
CmsVfsBundleParameters	getParameters()	Gets the bundle parameters.
protected Object	handleGetObject(String key)
protected Set<String>	handleKeySet()
static void	setCmsObject(CmsObject cms)	Sets the CMS context used by this class.
void	setLocale(Locale locale)	Sets the locale used for this resource bundle.
void	setParent(ResourceBundle p)	Sets the parent bundle.

Methods inherited from class java.util.ResourceBundle

clearCache, clearCache, containsKey, getBaseBundleName, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getBundle, getObject, getString, getStringArray, keySet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TYPE_PROPERTIES

public static final String TYPE_PROPERTIES

Name constant for the 'properties' vfs bundle type.

See Also:

• Constant Field Values

TYPE_XML

public static final String TYPE_XML

Name constant for the 'xml content' vfs bundle type.

See Also:

• Constant Field Values

m_cms

protected static CmsObject m_cms

The CMS context to use.

m_loader

protected CmsVfsResourceBundle.I_Loader m_loader

The bundle loader instance to use.

m_parameters

protected CmsVfsBundleParameters m_parameters

The VFS bundle parameters.

Constructor Details

CmsVfsResourceBundle

public CmsVfsResourceBundle(CmsVfsBundleParameters params)

Creates a new VFS bundle instance.

Parameters:

params - the VFS bundle parameters

Method Details

setCmsObject

public static void setCmsObject(CmsObject cms)

Sets the CMS context used by this class.

This can be never called more than once, and is usually called on startup.

Parameters:

cms - the CMS context to set

getClone

public CmsVfsResourceBundle getClone()

Description copied from interface: I_CmsResourceBundle

Creates a clone of the resource bundle.

(This may not actually clone the resource bundle if it is immutable).

Specified by:

getClone in interface I_CmsResourceBundle

Returns:

a clone of the resource bundle

See Also:

• I_CmsResourceBundle.getClone()

getKeys

public Enumeration<String> getKeys()

Specified by:

getKeys in class ResourceBundle

See Also:

• ResourceBundle.getKeys()

getLocale

public Locale getLocale()

Overrides:

getLocale in class ResourceBundle

See Also:

• ResourceBundle.getLocale()

getParameters

public CmsVfsBundleParameters getParameters()

Gets the bundle parameters.

Returns:

the bundle parameters

setLocale

public void setLocale(Locale locale)

Description copied from interface: I_CmsResourceBundle

Sets the locale used for this resource bundle.

Specified by:

setLocale in interface I_CmsResourceBundle

Parameters:

locale - the locale to set

See Also:

• I_CmsResourceBundle.setLocale(java.util.Locale)

setParent

public void setParent(ResourceBundle p)

Description copied from interface: I_CmsResourceBundle

Sets the parent bundle.

Specified by:

setParent in interface I_CmsResourceBundle

Overrides:

setParent in class ResourceBundle

Parameters:

p - the parent bundle to set

See Also:

• ResourceBundle.setParent(java.util.ResourceBundle)

getFilePath

protected String getFilePath()

Returns the path of the file to read the message data from.

Returns:

the root path of the file containing the message data

handleGetObject

protected Object handleGetObject(String key)

Specified by:

handleGetObject in class ResourceBundle

See Also:

• ResourceBundle.handleGetObject(java.lang.String)

handleKeySet

protected Set<String> handleKeySet()

Overrides:

handleKeySet in class ResourceBundle

See Also:

• ResourceBundle.handleKeySet()