org.eclipse.rse.services.clientserver
Class SystemEncodingUtil

java.lang.Object
  org.eclipse.rse.services.clientserver.SystemEncodingUtil

public class SystemEncodingUtil
extends java.lang.Object

A singleton class that contains useful methods related to encodings.

Nested Class Summary

static class

SystemEncodingUtil.DefaultEncodingProvider Provider for the default encodings that RSE uses.

Field Summary

static java.lang.String

ENCODING_UTF_8

Method Summary

java.lang.String	getEncodingFromBOM(java.lang.String filePath) Gets the encoding from the Byte Order Mark (BOM).
java.lang.String	getEnvironmentEncoding() Gets the encoding of the environment.
static SystemEncodingUtil	getInstance() Returns the singleton instance of the utility class.
java.lang.String	getLocalDefaultEncoding() Returns the local default encoding as provided by the default encoding provider.
java.lang.String	getXMLFileEncoding(java.lang.String filePath) Gets the encoding of an XML file.
boolean	isXML(java.lang.String filePath) Returns whether the file is an XML file.
void	setDefaultEncodingProvider(SystemEncodingUtil.DefaultEncodingProvider p) Change the default encoding provider.

Methods inherited from class java.lang.Object

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

Field Detail

ENCODING_UTF_8

public static java.lang.String ENCODING_UTF_8

Method Detail

getInstance

public static SystemEncodingUtil getInstance()

Returns the singleton instance of the utility class.

Returns:

the singleton instance.

setDefaultEncodingProvider

public void setDefaultEncodingProvider(SystemEncodingUtil.DefaultEncodingProvider p)

Change the default encoding provider. This is a system-wide change, and clients will not be notified of changed default encodings due to changing the provider. Therefore, changing the provider should be done only once during early system startup.

Parameters:

p - the new encoding provider.

Since:

3.0

getLocalDefaultEncoding

public java.lang.String getLocalDefaultEncoding()

Returns the local default encoding as provided by the default encoding provider. This method should be called after RSE startup is complete in order to get the proper default workspace encoding.

Returns:

the local default encoding

Since:

3.0

getEnvironmentEncoding

public java.lang.String getEnvironmentEncoding()

Gets the encoding of the environment. This is the encoding being used by the JVM, which by default is the machine encoding, unless changed explicitly.

Returns:

the evironment encoding.

isXML

public boolean isXML(java.lang.String filePath)

Returns whether the file is an XML file.

Parameters:

filePath - the file path.

Returns:

true if the file is an XML file, false otherwise.

getXMLFileEncoding

public java.lang.String getXMLFileEncoding(java.lang.String filePath)
                                    throws java.io.IOException

Gets the encoding of an XML file.

Parameters:

filePath - the file path.

Returns:

the encoding, or null if the encoding could not be determined.

Throws:

java.io.IOException

getEncodingFromBOM

public java.lang.String getEncodingFromBOM(java.lang.String filePath)
                                    throws java.io.IOException

Gets the encoding from the Byte Order Mark (BOM).

Parameters:

filePath - the file path.

Returns:

the encoding, or null if there is no BOM.

Throws:

java.io.IOException