org.spongycastle.i18n

Class LocalizedMessage

java.lang.Object

org.spongycastle.i18n.LocalizedMessage

Direct Known Subclasses:

LocaleString, TextBundle

public class LocalizedMessage
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	LocalizedMessage.FilteredArguments

Field Summary

Fields

Modifier and Type	Field and Description
protected LocalizedMessage.FilteredArguments	arguments
static java.lang.String	DEFAULT_ENCODING
protected java.lang.String	encoding
protected LocalizedMessage.FilteredArguments	extraArgs
protected Filter	filter
protected java.lang.String	id
protected java.lang.ClassLoader	loader
protected java.lang.String	resource

Constructor Summary

Constructors

Constructor and Description
LocalizedMessage(java.lang.String resource, java.lang.String id) Constructs a new LocalizedMessage using resource as the base name for the RessourceBundle and id as the message bundle id the resource file.
LocalizedMessage(java.lang.String resource, java.lang.String id, java.lang.Object[] arguments) Constructs a new LocalizedMessage using resource as the base name for the RessourceBundle and id as the message bundle id the resource file.
LocalizedMessage(java.lang.String resource, java.lang.String id, java.lang.String encoding) Constructs a new LocalizedMessage using resource as the base name for the RessourceBundle and id as the message bundle id the resource file.
LocalizedMessage(java.lang.String resource, java.lang.String id, java.lang.String encoding, java.lang.Object[] arguments) Constructs a new LocalizedMessage using resource as the base name for the RessourceBundle and id as the message bundle id the resource file.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	addExtraArgs(java.lang.String msg, java.util.Locale locale)
protected java.lang.String	formatWithTimeZone(java.lang.String template, java.lang.Object[] arguments, java.util.Locale locale, java.util.TimeZone timezone)
java.lang.Object[]	getArguments() Returns an Object[] containing the message arguments.
java.lang.ClassLoader	getClassLoader() Returns the ClassLoader which loads the resource files or null if the default ClassLoader is used.
java.lang.String	getEntry(java.lang.String key, java.util.Locale loc, java.util.TimeZone timezone) Reads the entry id + "." + key from the resource file and returns a formated message for the given Locale and TimeZone.
java.lang.Object[]	getExtraArgs()
Filter	getFilter() Returns the current filter.
java.lang.String	getId() Returns the id of the message in the resource bundle.
java.lang.String	getResource() Returns the name of the resource bundle for this message
void	setClassLoader(java.lang.ClassLoader loader) Set the ClassLoader which loads the resource files.
void	setExtraArgument(java.lang.Object extraArg)
void	setExtraArguments(java.lang.Object[] extraArgs)
void	setFilter(Filter filter) Sets the Filter that is used to filter the arguments of this message
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

id

protected final java.lang.String id

resource

protected final java.lang.String resource

DEFAULT_ENCODING

public static final java.lang.String DEFAULT_ENCODING

See Also:

Constant Field Values

encoding

protected java.lang.String encoding

arguments

protected LocalizedMessage.FilteredArguments arguments

extraArgs

protected LocalizedMessage.FilteredArguments extraArgs

filter

protected Filter filter

loader

protected java.lang.ClassLoader loader

Constructor Detail

LocalizedMessage

public LocalizedMessage(java.lang.String resource,
                        java.lang.String id)
                 throws java.lang.NullPointerException

Constructs a new LocalizedMessage using resource as the base name for the RessourceBundle and id as the message bundle id the resource file.

Parameters:

resource - base name of the resource file

id - the id of the corresponding bundle in the resource file

Throws:

java.lang.NullPointerException - if resource or id is null

LocalizedMessage

public LocalizedMessage(java.lang.String resource,
                        java.lang.String id,
                        java.lang.String encoding)
                 throws java.lang.NullPointerException,
                        java.io.UnsupportedEncodingException

Constructs a new LocalizedMessage using resource as the base name for the RessourceBundle and id as the message bundle id the resource file.

Parameters:

resource - base name of the resource file

id - the id of the corresponding bundle in the resource file

encoding - the encoding of the resource file

Throws:

java.lang.NullPointerException - if resource or id is null

java.io.UnsupportedEncodingException - if the encoding is not supported

LocalizedMessage

public LocalizedMessage(java.lang.String resource,
                        java.lang.String id,
                        java.lang.Object[] arguments)
                 throws java.lang.NullPointerException

Constructs a new LocalizedMessage using resource as the base name for the RessourceBundle and id as the message bundle id the resource file.

Parameters:

resource - base name of the resource file

id - the id of the corresponding bundle in the resource file

arguments - an array containing the arguments for the message

Throws:

java.lang.NullPointerException - if resource or id is null

LocalizedMessage

public LocalizedMessage(java.lang.String resource,
                        java.lang.String id,
                        java.lang.String encoding,
                        java.lang.Object[] arguments)
                 throws java.lang.NullPointerException,
                        java.io.UnsupportedEncodingException

Constructs a new LocalizedMessage using resource as the base name for the RessourceBundle and id as the message bundle id the resource file.

Parameters:

resource - base name of the resource file

id - the id of the corresponding bundle in the resource file

encoding - the encoding of the resource file

arguments - an array containing the arguments for the message

Throws:

java.lang.NullPointerException - if resource or id is null

java.io.UnsupportedEncodingException - if the encoding is not supported

Method Detail

getEntry

public java.lang.String getEntry(java.lang.String key,
                                 java.util.Locale loc,
                                 java.util.TimeZone timezone)
                          throws MissingEntryException

Reads the entry id + "." + key from the resource file and returns a formated message for the given Locale and TimeZone.

Parameters:

key - second part of the entry id

loc - the used Locale

timezone - the used TimeZone

Returns:

a Strng containing the localized message

Throws:

MissingEntryException - if the resource file is not available or the entry does not exist.

formatWithTimeZone

protected java.lang.String formatWithTimeZone(java.lang.String template,
                                              java.lang.Object[] arguments,
                                              java.util.Locale locale,
                                              java.util.TimeZone timezone)

addExtraArgs

protected java.lang.String addExtraArgs(java.lang.String msg,
                                        java.util.Locale locale)

setFilter

public void setFilter(Filter filter)

Sets the Filter that is used to filter the arguments of this message

Parameters:

filter - the Filter to use. null to disable filtering.

getFilter

public Filter getFilter()

Returns the current filter.

Returns:

the current filter

setClassLoader

public void setClassLoader(java.lang.ClassLoader loader)

Set the ClassLoader which loads the resource files. If it is set to null then the default ClassLoader is used.

Parameters:

loader - the ClassLoader which loads the resource files

getClassLoader

public java.lang.ClassLoader getClassLoader()

Returns the ClassLoader which loads the resource files or null if the default ClassLoader is used.

Returns:

the ClassLoader which loads the resource files

getId

public java.lang.String getId()

Returns the id of the message in the resource bundle.

Returns:

the id of the message

getResource

public java.lang.String getResource()

Returns the name of the resource bundle for this message

Returns:

name of the resource file

getArguments

public java.lang.Object[] getArguments()

Returns an Object[] containing the message arguments.

Returns:

the message arguments

setExtraArgument

public void setExtraArgument(java.lang.Object extraArg)

Parameters:

extraArg -

setExtraArguments

public void setExtraArguments(java.lang.Object[] extraArgs)

Parameters:

extraArgs -

getExtraArgs

public java.lang.Object[] getExtraArgs()

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object