CmsEncoder

java.lang.Object
- org.opencms.i18n.CmsEncoder

```
public final class CmsEncoder
extends java.lang.Object
```
The OpenCms CmsEncoder class provides static methods to decode and encode data.
The methods in this class are substitutes for java.net.URLEncoder.encode() and java.net.URLDecoder.decode(). Use the methods from this class in all OpenCms core classes to ensure the encoding is always handled the same way.
The de- and encoding uses the same coding mechanism as JavaScript, special characters are replaced with %hex where hex is a two digit hex number.
Note: On the client side (browser) instead of using corresponding escape and unescape JavaScript functions, better use encodeURIComponent and decodeURIComponent functions which are work properly with unicode characters. These functions are supported in IE 5.5+ and NS 6+ only.

从以下版本开始:

6.0.0

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`ENCODING_ISO_8859_1` Constant for the standard `ISO-8859-1` encoding.
`static java.lang.String`	`ENCODING_US_ASCII` Constant for the standard `US-ASCII` encoding.
`static java.lang.String`	`ENCODING_UTF_8` Constant for the standard `UTF-8` encoding.

方法概要

方法
限定符和类型	方法和说明
`static java.lang.String`	`adjustHtmlEncoding(java.lang.String input, java.lang.String encoding)` Adjusts the given String by making sure all characters that can be displayed in the given charset are contained as chars, whereas all other non-displayable characters are converted to HTML entities.
`static byte[]`	`changeEncoding(byte[] input, java.lang.String oldEncoding, java.lang.String newEncoding)` Changes the encoding of a byte array that represents a String.
`static java.lang.String`	`createString(byte[] bytes, java.lang.String encoding)` Creates a String out of a byte array with the specified encoding, falling back to the system default in case the encoding name is not valid.
`static java.lang.String`	`decode(java.lang.String source)` Decodes a String using UTF-8 encoding, which is the standard for http data transmission with GET ant POST requests.
`static java.lang.String`	`decode(java.lang.String source, java.lang.String encoding)` This method is a substitute for `URLDecoder.decode()`.
`static java.lang.String`	`decodeHtmlEntities(java.lang.String input, java.lang.String encoding)` Decodes HTML entity references like `€` that are contained in the String to a regular character, but only if that character is contained in the given encodings charset.
`static java.lang.String`	`decodeParameter(java.lang.String input)` Decodes a string used as parameter in an uri in a way independent of other encodings/decodings applied before.
`static java.lang.String`	`encode(java.lang.String source)` Encodes a String using UTF-8 encoding, which is the standard for http data transmission with GET ant POST requests.
`static java.lang.String`	`encode(java.lang.String source, java.lang.String encoding)` This method is a substitute for `URLEncoder.encode()`.
`static java.lang.String`	`encodeHtmlEntities(java.lang.String input, java.lang.String encoding)` Encodes all characters that are contained in the String which can not displayed in the given encodings charset with HTML entity references like `€`.
`static java.lang.String`	`encodeJavaEntities(java.lang.String input, java.lang.String encoding)` Encodes all characters that are contained in the String which can not displayed in the given encodings charset with Java escaping like `€`.
`static java.lang.String`	`encodeParameter(java.lang.String input)` Encodes a string used as parameter in an uri in a way independent of other encodings/decodings applied later.
`static java.lang.String`	`escape(java.lang.String source, java.lang.String encoding)` Encodes a String in a way that is compatible with the JavaScript escape function.
`static java.lang.String`	`escapeHtml(java.lang.String source)` Escapes special characters in a HTML-String with their number-based entity representation, for example & becomes &.
`static java.lang.String`	`escapeNonAscii(java.lang.String source)` Escapes non ASCII characters in a HTML-String with their number-based entity representation, for example & becomes &.
`static java.lang.String`	`escapeSql(java.lang.String source)` A simple method to avoid injection.
`static java.lang.String`	`escapeSqlLikePattern(java.lang.String pattern, char escapeChar)` Escapes the wildcard characters in a string which will be used as the pattern for a SQL LIKE clause.
`static java.lang.String`	`escapeWBlanks(java.lang.String source, java.lang.String encoding)` Encodes a String in a way that is compatible with the JavaScript escape function.
`static java.lang.String`	`escapeXml(java.lang.String source)` Escapes a String so it may be printed as text content or attribute value in a HTML page or an XML file.
`static java.lang.String`	`escapeXml(java.lang.String source, boolean doubleEscape)` Escapes a String so it may be printed as text content or attribute value in a HTML page or an XML file.
`static java.lang.String`	`lookupEncoding(java.lang.String encoding, java.lang.String fallback)` Checks if a given encoding name is actually supported, and if so resolves it to it's canonical name, if not it returns the given fallback value.
`static java.lang.String`	`redecodeUriComponent(java.lang.String input)` Re-decodes a String that has not been correctly decoded and thus has scrambled character bytes.
`static java.lang.String`	`unescape(java.lang.String source, java.lang.String encoding)` Decodes a String in a way that is compatible with the JavaScript unescape function.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - ENCODING_ISO_8859_1
```
public static final java.lang.String ENCODING_ISO_8859_1
```
    Constant for the standard ISO-8859-1 encoding.
    
    另请参阅:
    常量字段值
  - ENCODING_US_ASCII
```
public static final java.lang.String ENCODING_US_ASCII
```
    Constant for the standard US-ASCII encoding.
    
    另请参阅:
    常量字段值
  - ENCODING_UTF_8
```
public static final java.lang.String ENCODING_UTF_8
```
    Constant for the standard UTF-8 encoding.
    Default encoding for JavaScript decodeUriComponent methods is UTF-8 by w3c standard.
    
    另请参阅:
    常量字段值
- 方法详细资料
  - adjustHtmlEncoding
```
public static java.lang.String adjustHtmlEncoding(java.lang.String input,
                                  java.lang.String encoding)
```
    Adjusts the given String by making sure all characters that can be displayed in the given charset are contained as chars, whereas all other non-displayable characters are converted to HTML entities.
    Just calls decodeHtmlEntities(String, String) first and feeds the result to encodeHtmlEntities(String, String).
    
    参数:
    input - the input to adjust the HTML encoding for
    encoding - the charset to encode the result with\
    
    返回:
    the input with the decoded/encoded HTML entities
  - changeEncoding
```
public static byte[] changeEncoding(byte[] input,
                    java.lang.String oldEncoding,
                    java.lang.String newEncoding)
```
    Changes the encoding of a byte array that represents a String.
    
    参数:
    input - the byte array to convert
    oldEncoding - the current encoding of the byte array
    newEncoding - the new encoding of the byte array
    
    返回:
    the byte array encoded in the new encoding
  - createString
```
public static java.lang.String createString(byte[] bytes,
                            java.lang.String encoding)
```
    Creates a String out of a byte array with the specified encoding, falling back to the system default in case the encoding name is not valid.
    Use this method as a replacement for new String(byte[], encoding) to avoid possible encoding problems.
    
    参数:
    bytes - the bytes to decode
    encoding - the encoding scheme to use for decoding the bytes
    
    返回:
    the bytes decoded to a String
  - decode
```
public static java.lang.String decode(java.lang.String source)
```
    Decodes a String using UTF-8 encoding, which is the standard for http data transmission with GET ant POST requests.
    
    参数:
    source - the String to decode
    
    返回:
    String the decoded source String
  - decode
```
public static java.lang.String decode(java.lang.String source,
                      java.lang.String encoding)
```
    This method is a substitute for URLDecoder.decode(). Use this in all OpenCms core classes to ensure the encoding is always handled the same way.
    In case you don't know what encoding to use, set the value of the encoding parameter to null. This method will then default to UTF-8 encoding, which is probably the right one.
    
    参数:
    source - The string to decode
    encoding - The encoding to use (if null, the system default is used)
    
    返回:
    The decoded source String
  - decodeHtmlEntities
```
public static java.lang.String decodeHtmlEntities(java.lang.String input,
                                  java.lang.String encoding)
```
    Decodes HTML entity references like € that are contained in the String to a regular character, but only if that character is contained in the given encodings charset.
    
    参数:
    input - the input to decode the HTML entities in
    encoding - the charset to decode the input for
    
    返回:
    the input with the decoded HTML entities
    另请参阅:
    encodeHtmlEntities(String, String)
  - decodeParameter
```
public static java.lang.String decodeParameter(java.lang.String input)
```
    Decodes a string used as parameter in an uri in a way independent of other encodings/decodings applied before.
    
    参数:
    input - the encoded parameter string
    
    返回:
    the decoded parameter string
    另请参阅:
    encodeParameter(String)
  - encode
```
public static java.lang.String encode(java.lang.String source)
```
    Encodes a String using UTF-8 encoding, which is the standard for http data transmission with GET ant POST requests.
    
    参数:
    source - the String to encode
    
    返回:
    String the encoded source String
  - encode
```
public static java.lang.String encode(java.lang.String source,
                      java.lang.String encoding)
```
    This method is a substitute for URLEncoder.encode(). Use this in all OpenCms core classes to ensure the encoding is always handled the same way.
    In case you don't know what encoding to use, set the value of the encoding parameter to null. This method will then default to UTF-8 encoding, which is probably the right one.
    
    参数:
    source - the String to encode
    encoding - the encoding to use (if null, the system default is used)
    
    返回:
    the encoded source String
  - encodeHtmlEntities
```
public static java.lang.String encodeHtmlEntities(java.lang.String input,
                                  java.lang.String encoding)
```
    Encodes all characters that are contained in the String which can not displayed in the given encodings charset with HTML entity references like €.
    This is required since a Java String is internally always stored as Unicode, meaning it can contain almost every character, but the HTML charset used might not support all such characters.
    
    参数:
    input - the input to encode for HTML
    encoding - the charset to encode the result with
    
    返回:
    the input with the encoded HTML entities
    另请参阅:
    decodeHtmlEntities(String, String)
  - encodeJavaEntities
```
public static java.lang.String encodeJavaEntities(java.lang.String input,
                                  java.lang.String encoding)
```
    Encodes all characters that are contained in the String which can not displayed in the given encodings charset with Java escaping like €.
    This can be used to escape values used in Java property files.
    
    参数:
    input - the input to encode for Java
    encoding - the charset to encode the result with
    
    返回:
    the input with the encoded Java entities
  - encodeParameter
```
public static java.lang.String encodeParameter(java.lang.String input)
```
    Encodes a string used as parameter in an uri in a way independent of other encodings/decodings applied later.
    Used to ensure that GET parameters are not wrecked by wrong or incompatible configuration settings. In order to ensure this, the String is first encoded with html entities for any character that cannot encoded in US-ASCII; additionally, the plus sign is also encoded to avoid problems with the white-space replacer. Finally, the entity prefix is replaced with characters not used as delimiters in urls.
    
    参数:
    input - the parameter string
    
    返回:
    the encoded parameter string
  - escape
```
public static java.lang.String escape(java.lang.String source,
                      java.lang.String encoding)
```
    Encodes a String in a way that is compatible with the JavaScript escape function.
    
    参数:
    source - The text to be encoded
    encoding - the encoding type
    
    返回:
    The JavaScript escaped string
  - escapeHtml
```
public static java.lang.String escapeHtml(java.lang.String source)
```
    Escapes special characters in a HTML-String with their number-based entity representation, for example & becomes &.
    A character num is replaced if
    ((ch != 32) && ((ch > 122) || (ch < 48) || (ch == 60) || (ch == 62)))
    
    参数:
    source - the String to escape
    
    返回:
    String the escaped String
    另请参阅:
    escapeXml(String)
  - escapeNonAscii
```
public static java.lang.String escapeNonAscii(java.lang.String source)
```
    Escapes non ASCII characters in a HTML-String with their number-based entity representation, for example & becomes &.
    A character num is replaced if
    (ch > 255)
    
    参数:
    source - the String to escape
    
    返回:
    String the escaped String
    另请参阅:
    escapeXml(String)
  - escapeSql
```
public static java.lang.String escapeSql(java.lang.String source)
```
    A simple method to avoid injection.
    Replaces all single quotes to double single quotes in the value parameter of the SQL statement.
    
    参数:
    source - the String to escape SQL from
    
    返回:
    the escaped value of the parameter source
  - escapeSqlLikePattern
```
public static java.lang.String escapeSqlLikePattern(java.lang.String pattern,
                                    char escapeChar)
```
    Escapes the wildcard characters in a string which will be used as the pattern for a SQL LIKE clause.
    
    参数:
    pattern - the pattern
    escapeChar - the character which should be used as the escape character
    
    返回:
    the escaped pattern
  - escapeWBlanks
```
public static java.lang.String escapeWBlanks(java.lang.String source,
                             java.lang.String encoding)
```
    Encodes a String in a way that is compatible with the JavaScript escape function. Multiple blanks are encoded _multiply _with %20.
    
    参数:
    source - The text to be encoded
    encoding - the encoding type
    
    返回:
    The JavaScript escaped string
  - escapeXml
```
public static java.lang.String escapeXml(java.lang.String source)
```
    Escapes a String so it may be printed as text content or attribute value in a HTML page or an XML file.
    This method replaces the following characters in a String:
    - < with <
    - > with >
    - & with &
    - " with "
    参数:
    source - the string to escape
    
    返回:
    the escaped string
    另请参阅:
    escapeHtml(String)
  - escapeXml
```
public static java.lang.String escapeXml(java.lang.String source,
                         boolean doubleEscape)
```
    Escapes a String so it may be printed as text content or attribute value in a HTML page or an XML file.
    This method replaces the following characters in a String:
    - < with <
    - > with >
    - & with &
    - " with "
    参数:
    source - the string to escape
    doubleEscape - if false, all entities that already are escaped are left untouched
    
    返回:
    the escaped string
    另请参阅:
    escapeHtml(String)
  - lookupEncoding
```
public static java.lang.String lookupEncoding(java.lang.String encoding,
                              java.lang.String fallback)
```
    Checks if a given encoding name is actually supported, and if so resolves it to it's canonical name, if not it returns the given fallback value.
    Charsets have a set of aliases. For example, valid aliases for "UTF-8" are "UTF8", "utf-8" or "utf8". This method resolves any given valid charset name to it's "canonical" form, so that simple String comparison can be used when checking charset names internally later.
    Please see http://www.iana.org/assignments/character-sets for a list of valid charset alias names.
    
    参数:
    encoding - the encoding to check and resolve
    fallback - the fallback encoding scheme
    
    返回:
    the resolved encoding name, or the fallback value
  - redecodeUriComponent
```
public static java.lang.String redecodeUriComponent(java.lang.String input)
```
    Re-decodes a String that has not been correctly decoded and thus has scrambled character bytes.
    This is an equivalent to the JavaScript "decodeURIComponent" function. It converts from the default "UTF-8" to the currently selected system encoding.
    
    参数:
    input - the String to convert
    
    返回:
    String the converted String
  - unescape
```
public static java.lang.String unescape(java.lang.String source,
                        java.lang.String encoding)
```
    Decodes a String in a way that is compatible with the JavaScript unescape function.
    
    参数:
    source - The String to be decoded
    encoding - the encoding type
    
    返回:
    The JavaScript unescaped String

类 CmsEncoder

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

ENCODING_ISO_8859_1

ENCODING_US_ASCII

ENCODING_UTF_8

方法详细资料

adjustHtmlEncoding

changeEncoding

createString

decode

decode

decodeHtmlEntities

decodeParameter

encode

encode

encodeHtmlEntities

encodeJavaEntities

encodeParameter

escape

escapeHtml

escapeNonAscii

escapeSql

escapeSqlLikePattern

escapeWBlanks

escapeXml

escapeXml

lookupEncoding

redecodeUriComponent

unescape