Package org.apache.catalina.util

Class CharsetMapper

java.lang.Object

org.apache.catalina.util.CharsetMapper

All Implemented Interfaces:

Cloneable

public class CharsetMapper
extends Object
implements Cloneable

Utility class that attempts to map from a Locale to the corresponding character set to be used for interpreting input text (or generating output text) when the Content-Type header does not include one. You can customize the behavior of this class by modifying the mapping data it loads, or by subclassing it (to change the algorithm) and then using your own version for a particular web application.

Author:

Craig R. McClanahan

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_RESOURCE	Default properties resource name.
protected Properties	map	The mapping properties that have been initialized from the specified or default properties resource.

Constructor Summary

Constructors

Constructor	Description
CharsetMapper()	Construct a new CharsetMapper using the default properties resource.
CharsetMapper(String name)	Construct a new CharsetMapper using the specified properties resource.

Method Summary

Modifier and Type	Method	Description
void	addCharsetMappingFromDeploymentDescriptor(String locale, String charset)	The deployment descriptor can have a locale-encoding-mapping-list element which describes the webapp's desired mapping from locale to charset.
Object	clone()
String	getCharset(Locale locale)	Calculate the name of a character set to be assumed, given the specified Locale and the absence of a character set specified as part of the content type header.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RESOURCE

public static final String DEFAULT_RESOURCE

Default properties resource name.

See Also:

Constant Field Values

map

protected Properties map

The mapping properties that have been initialized from the specified or default properties resource.

Constructor Detail

CharsetMapper

public CharsetMapper()

Construct a new CharsetMapper using the default properties resource.

CharsetMapper

public CharsetMapper(String name)

Construct a new CharsetMapper using the specified properties resource.

Parameters:

name - Name of a properties resource to be loaded

Throws:

IllegalArgumentException - if the specified properties resource could not be loaded for any reason.

Method Detail

getCharset

public String getCharset(Locale locale)

Calculate the name of a character set to be assumed, given the specified Locale and the absence of a character set specified as part of the content type header.

Parameters:

locale - The locale for which to calculate a character set

addCharsetMappingFromDeploymentDescriptor

public void addCharsetMappingFromDeploymentDescriptor(String locale,
                                                      String charset)

The deployment descriptor can have a locale-encoding-mapping-list element which describes the webapp's desired mapping from locale to charset. This method gets called when processing the web.xml file for a context

Parameters:

locale - The locale for a character set

charset - The charset to be associated with the locale

clone

public final Object clone()

Overrides:

clone in class Object