com.mysql.cj

Class CharsetMapping

java.lang.Object

com.mysql.cj.CharsetMapping

Direct Known Subclasses:

NativeCharsetSettings

public class CharsetMapping
extends java.lang.Object

Mapping between MySQL charset names and Java charset names. I've investigated placing these in a .properties file, but unfortunately under most appservers this complicates configuration because the security policy needs to be changed by the user to allow the driver to read them :(

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAP_SIZE
static java.lang.String	MYSQL_CHARSET_NAME_armscii8
static java.lang.String	MYSQL_CHARSET_NAME_ascii
static java.lang.String	MYSQL_CHARSET_NAME_big5
static java.lang.String	MYSQL_CHARSET_NAME_binary
static java.lang.String	MYSQL_CHARSET_NAME_cp1250
static java.lang.String	MYSQL_CHARSET_NAME_cp1251
static java.lang.String	MYSQL_CHARSET_NAME_cp1256
static java.lang.String	MYSQL_CHARSET_NAME_cp1257
static java.lang.String	MYSQL_CHARSET_NAME_cp850
static java.lang.String	MYSQL_CHARSET_NAME_cp852
static java.lang.String	MYSQL_CHARSET_NAME_cp866
static java.lang.String	MYSQL_CHARSET_NAME_cp932
static java.lang.String	MYSQL_CHARSET_NAME_dec8
static java.lang.String	MYSQL_CHARSET_NAME_eucjpms
static java.lang.String	MYSQL_CHARSET_NAME_euckr
static java.lang.String	MYSQL_CHARSET_NAME_gb18030
static java.lang.String	MYSQL_CHARSET_NAME_gb2312
static java.lang.String	MYSQL_CHARSET_NAME_gbk
static java.lang.String	MYSQL_CHARSET_NAME_geostd8
static java.lang.String	MYSQL_CHARSET_NAME_greek
static java.lang.String	MYSQL_CHARSET_NAME_hebrew
static java.lang.String	MYSQL_CHARSET_NAME_hp8
static java.lang.String	MYSQL_CHARSET_NAME_keybcs2
static java.lang.String	MYSQL_CHARSET_NAME_koi8r
static java.lang.String	MYSQL_CHARSET_NAME_koi8u
static java.lang.String	MYSQL_CHARSET_NAME_latin1
static java.lang.String	MYSQL_CHARSET_NAME_latin2
static java.lang.String	MYSQL_CHARSET_NAME_latin5
static java.lang.String	MYSQL_CHARSET_NAME_latin7
static java.lang.String	MYSQL_CHARSET_NAME_macce
static java.lang.String	MYSQL_CHARSET_NAME_macroman
static java.lang.String	MYSQL_CHARSET_NAME_sjis
static java.lang.String	MYSQL_CHARSET_NAME_swe7
static java.lang.String	MYSQL_CHARSET_NAME_tis620
static java.lang.String	MYSQL_CHARSET_NAME_ucs2
static java.lang.String	MYSQL_CHARSET_NAME_ujis
static java.lang.String	MYSQL_CHARSET_NAME_utf16
static java.lang.String	MYSQL_CHARSET_NAME_utf16le
static java.lang.String	MYSQL_CHARSET_NAME_utf32
static java.lang.String	MYSQL_CHARSET_NAME_utf8
static java.lang.String	MYSQL_CHARSET_NAME_utf8mb3
static java.lang.String	MYSQL_CHARSET_NAME_utf8mb4
static int	MYSQL_COLLATION_INDEX_binary
static int	MYSQL_COLLATION_INDEX_utf8mb4_0900_ai_ci
static int	MYSQL_COLLATION_INDEX_utf8mb4_general_ci

Constructor Summary

Constructors

Constructor and Description
CharsetMapping()

Method Summary

Modifier and Type	Method and Description
protected static java.lang.Integer	getStaticCollationIndexForCollationName(java.lang.String collationName)
protected static int	getStaticCollationIndexForJavaEncoding(java.lang.String javaEncoding, ServerVersion version)
protected static int	getStaticCollationIndexForMysqlCharsetName(java.lang.String charsetName)
static java.lang.String	getStaticCollationNameForCollationIndex(java.lang.Integer collationIndex)
static java.lang.String	getStaticJavaEncodingForCollationIndex(java.lang.Integer collationIndex)
protected static java.lang.String	getStaticJavaEncodingForCollationIndex(java.lang.Integer collationIndex, java.lang.String fallbackJavaEncoding)
protected static java.lang.String	getStaticJavaEncodingForMysqlCharset(java.lang.String mysqlCharsetName)
protected static java.lang.String	getStaticJavaEncodingForMysqlCharset(java.lang.String mysqlCharsetName, java.lang.String fallbackJavaEncoding) MySQL charset could map to several Java encodings.
protected static int	getStaticMblen(java.lang.String charsetName)
protected static java.util.List<java.lang.String>	getStaticMysqlCharsetAliasesByName(java.lang.String mysqlCharsetName)
protected static com.mysql.cj.MysqlCharset	getStaticMysqlCharsetByName(java.lang.String mysqlCharsetName)
protected static java.lang.String	getStaticMysqlCharsetForJavaEncoding(java.lang.String javaEncoding, ServerVersion version)
static java.lang.String	getStaticMysqlCharsetNameForCollationIndex(java.lang.Integer collationIndex)
protected static boolean	isStaticImpermissibleCollation(int collationIndex)
protected static boolean	isStaticMultibyteCharset(java.lang.String javaEncodingName) Does the character set contain multi-byte encoded characters.

Methods inherited from class java.lang.Object

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

Field Detail

MAP_SIZE

public static final int MAP_SIZE

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_armscii8

public static final java.lang.String MYSQL_CHARSET_NAME_armscii8

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_ascii

public static final java.lang.String MYSQL_CHARSET_NAME_ascii

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_big5

public static final java.lang.String MYSQL_CHARSET_NAME_big5

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_binary

public static final java.lang.String MYSQL_CHARSET_NAME_binary

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_cp1250

public static final java.lang.String MYSQL_CHARSET_NAME_cp1250

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_cp1251

public static final java.lang.String MYSQL_CHARSET_NAME_cp1251

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_cp1256

public static final java.lang.String MYSQL_CHARSET_NAME_cp1256

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_cp1257

public static final java.lang.String MYSQL_CHARSET_NAME_cp1257

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_cp850

public static final java.lang.String MYSQL_CHARSET_NAME_cp850

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_cp852

public static final java.lang.String MYSQL_CHARSET_NAME_cp852

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_cp866

public static final java.lang.String MYSQL_CHARSET_NAME_cp866

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_cp932

public static final java.lang.String MYSQL_CHARSET_NAME_cp932

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_dec8

public static final java.lang.String MYSQL_CHARSET_NAME_dec8

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_eucjpms

public static final java.lang.String MYSQL_CHARSET_NAME_eucjpms

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_euckr

public static final java.lang.String MYSQL_CHARSET_NAME_euckr

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_gb18030

public static final java.lang.String MYSQL_CHARSET_NAME_gb18030

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_gb2312

public static final java.lang.String MYSQL_CHARSET_NAME_gb2312

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_gbk

public static final java.lang.String MYSQL_CHARSET_NAME_gbk

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_geostd8

public static final java.lang.String MYSQL_CHARSET_NAME_geostd8

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_greek

public static final java.lang.String MYSQL_CHARSET_NAME_greek

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_hebrew

public static final java.lang.String MYSQL_CHARSET_NAME_hebrew

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_hp8

public static final java.lang.String MYSQL_CHARSET_NAME_hp8

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_keybcs2

public static final java.lang.String MYSQL_CHARSET_NAME_keybcs2

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_koi8r

public static final java.lang.String MYSQL_CHARSET_NAME_koi8r

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_koi8u

public static final java.lang.String MYSQL_CHARSET_NAME_koi8u

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_latin1

public static final java.lang.String MYSQL_CHARSET_NAME_latin1

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_latin2

public static final java.lang.String MYSQL_CHARSET_NAME_latin2

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_latin5

public static final java.lang.String MYSQL_CHARSET_NAME_latin5

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_latin7

public static final java.lang.String MYSQL_CHARSET_NAME_latin7

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_macce

public static final java.lang.String MYSQL_CHARSET_NAME_macce

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_macroman

public static final java.lang.String MYSQL_CHARSET_NAME_macroman

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_sjis

public static final java.lang.String MYSQL_CHARSET_NAME_sjis

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_swe7

public static final java.lang.String MYSQL_CHARSET_NAME_swe7

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_tis620

public static final java.lang.String MYSQL_CHARSET_NAME_tis620

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_ucs2

public static final java.lang.String MYSQL_CHARSET_NAME_ucs2

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_ujis

public static final java.lang.String MYSQL_CHARSET_NAME_ujis

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_utf16

public static final java.lang.String MYSQL_CHARSET_NAME_utf16

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_utf16le

public static final java.lang.String MYSQL_CHARSET_NAME_utf16le

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_utf32

public static final java.lang.String MYSQL_CHARSET_NAME_utf32

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_utf8

public static final java.lang.String MYSQL_CHARSET_NAME_utf8

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_utf8mb3

public static final java.lang.String MYSQL_CHARSET_NAME_utf8mb3

See Also:

Constant Field Values

MYSQL_CHARSET_NAME_utf8mb4

public static final java.lang.String MYSQL_CHARSET_NAME_utf8mb4

See Also:

Constant Field Values

MYSQL_COLLATION_INDEX_utf8mb4_general_ci

public static final int MYSQL_COLLATION_INDEX_utf8mb4_general_ci

See Also:

Constant Field Values

MYSQL_COLLATION_INDEX_utf8mb4_0900_ai_ci

public static final int MYSQL_COLLATION_INDEX_utf8mb4_0900_ai_ci

See Also:

Constant Field Values

MYSQL_COLLATION_INDEX_binary

public static final int MYSQL_COLLATION_INDEX_binary

See Also:

Constant Field Values

Constructor Detail

CharsetMapping

public CharsetMapping()

Method Detail

getStaticMysqlCharsetForJavaEncoding

protected static java.lang.String getStaticMysqlCharsetForJavaEncoding(java.lang.String javaEncoding,
                                                                       ServerVersion version)

getStaticCollationIndexForJavaEncoding

protected static int getStaticCollationIndexForJavaEncoding(java.lang.String javaEncoding,
                                                            ServerVersion version)

getStaticCollationIndexForMysqlCharsetName

protected static int getStaticCollationIndexForMysqlCharsetName(java.lang.String charsetName)

getStaticMysqlCharsetNameForCollationIndex

public static java.lang.String getStaticMysqlCharsetNameForCollationIndex(java.lang.Integer collationIndex)

getStaticCollationNameForCollationIndex

public static java.lang.String getStaticCollationNameForCollationIndex(java.lang.Integer collationIndex)

getStaticCollationIndexForCollationName

protected static java.lang.Integer getStaticCollationIndexForCollationName(java.lang.String collationName)

getStaticJavaEncodingForMysqlCharset

protected static java.lang.String getStaticJavaEncodingForMysqlCharset(java.lang.String mysqlCharsetName,
                                                                       java.lang.String fallbackJavaEncoding)

MySQL charset could map to several Java encodings. So here we choose the one according to next rules:

• if there is no static mapping for this charset then return javaEncoding value as is because this could be a custom charset for example
• if static mapping exists and javaEncoding equals to one of Java encoding canonical names or aliases available for this mapping then javaEncoding value as is; this is required when result should match to connection encoding, for example if connection encoding is Cp943 we must avoid getting SHIFT_JIS for sjis mysql charset
• if static mapping exists and javaEncoding doesn't match any Java encoding canonical names or aliases available for this mapping then return default Java encoding (the first in mapping list)

Parameters:

mysqlCharsetName - MySQL charset name

fallbackJavaEncoding - fall-back java encoding name

Returns:

java encoding name

getStaticMysqlCharsetByName

protected static com.mysql.cj.MysqlCharset getStaticMysqlCharsetByName(java.lang.String mysqlCharsetName)

getStaticMysqlCharsetAliasesByName

protected static java.util.List<java.lang.String> getStaticMysqlCharsetAliasesByName(java.lang.String mysqlCharsetName)

getStaticJavaEncodingForMysqlCharset

protected static java.lang.String getStaticJavaEncodingForMysqlCharset(java.lang.String mysqlCharsetName)

getStaticJavaEncodingForCollationIndex

protected static java.lang.String getStaticJavaEncodingForCollationIndex(java.lang.Integer collationIndex,
                                                                         java.lang.String fallbackJavaEncoding)

getStaticJavaEncodingForCollationIndex

public static java.lang.String getStaticJavaEncodingForCollationIndex(java.lang.Integer collationIndex)

isStaticMultibyteCharset

protected static boolean isStaticMultibyteCharset(java.lang.String javaEncodingName)

Does the character set contain multi-byte encoded characters.

Parameters:

javaEncodingName - java encoding name

Returns:

true if the character set contains multi-byte encoded characters.

getStaticMblen

protected static int getStaticMblen(java.lang.String charsetName)

isStaticImpermissibleCollation

protected static boolean isStaticImpermissibleCollation(int collationIndex)