org.opencms.gwt
Class A_CmsClientMessageBundle

java.lang.Object
  extended by org.opencms.gwt.A_CmsClientMessageBundle
All Implemented Interfaces:
I_CmsClientMessageBundle
Direct Known Subclasses:
ClientMessages, ClientMessages, ClientMessages, ClientMessages, ClientMessages, ClientMessages

public abstract class A_CmsClientMessageBundle
extends Object
implements I_CmsClientMessageBundle

Convenience class to access the localized messages of this OpenCms package.

Intended only for test cases.

Since:
8.0.0

Constructor Summary
protected A_CmsClientMessageBundle()
          Hides the public constructor for this utility class.
 
Method Summary
 String export(javax.servlet.http.HttpServletRequest request)
          Returns the JSON code for this resource bundle and the default locale.
 String export(Locale locale)
          Returns the JSON code for this resource bundle and given locale.
 String export(String localeName)
          Returns the JSON code for this resource bundle and given locale.
 String getBundleName()
          Returns the bundle name for this OpenCms package.
 Class<?> getClientImpl()
          Returns the class of the client implementation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

A_CmsClientMessageBundle

protected A_CmsClientMessageBundle()
Hides the public constructor for this utility class.

Method Detail

export

public String export(javax.servlet.http.HttpServletRequest request)
Description copied from interface: I_CmsClientMessageBundle
Returns the JSON code for this resource bundle and the default locale.

Specified by:
export in interface I_CmsClientMessageBundle
Parameters:
request - the current request to get the default locale from
Returns:
the JSON code
See Also:
I_CmsClientMessageBundle.export(javax.servlet.http.HttpServletRequest)

export

public String export(String localeName)
Description copied from interface: I_CmsClientMessageBundle
Returns the JSON code for this resource bundle and given locale.

Specified by:
export in interface I_CmsClientMessageBundle
Parameters:
localeName - the name of the locale to export
Returns:
the JSON code
See Also:
I_CmsClientMessageBundle.export(java.lang.String)

export

public String export(Locale locale)
Description copied from interface: I_CmsClientMessageBundle
Returns the JSON code for this resource bundle and given locale.

Specified by:
export in interface I_CmsClientMessageBundle
Parameters:
locale - the locale to export
Returns:
the JSON code
See Also:
I_CmsClientMessageBundle.export(java.util.Locale)

getBundleName

public String getBundleName()
Description copied from interface: I_CmsClientMessageBundle
Returns the bundle name for this OpenCms package.

Specified by:
getBundleName in interface I_CmsClientMessageBundle
Returns:
the bundle name for this OpenCms package
See Also:
I_CmsClientMessageBundle.getBundleName()

getClientImpl

public Class<?> getClientImpl()
                       throws Exception
Description copied from interface: I_CmsClientMessageBundle
Returns the class of the client implementation.

Specified by:
getClientImpl in interface I_CmsClientMessageBundle
Returns:
the class of the client implementation
Throws:
Exception - if something goes wrong
See Also:
I_CmsClientMessageBundle.getClientImpl()