Package org.firebirdsql.encodings
Class DefaultEncodingDefinition
- java.lang.Object
- 
- org.firebirdsql.encodings.DefaultEncodingDefinition
 
- 
- All Implemented Interfaces:
- EncodingDefinition
 
 public final class DefaultEncodingDefinition extends java.lang.Object implements EncodingDefinition Definition of a Firebird encoding. This is the default implementation ofEncodingDefinition.- Since:
- 3.0
- Author:
- Mark Rotteveel
 
- 
- 
Constructor SummaryConstructors Constructor Description DefaultEncodingDefinition(java.lang.String firebirdEncodingName, java.lang.String charsetName, int maxBytesPerChar, int firebirdCharacterSetId, boolean firebirdOnly)Initializes an instance of DefaultEncodingDefinition.DefaultEncodingDefinition(java.lang.String firebirdEncodingName, java.nio.charset.Charset charset, int maxBytesPerChar, int firebirdCharacterSetId, boolean firebirdOnly)Initializes an instance of DefaultEncodingDefinition.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description EncodinggetEncoding()Returns theEncodinginstance for this definition.intgetFirebirdCharacterSetId()java.lang.StringgetFirebirdEncodingName()java.nio.charset.CharsetgetJavaCharset()java.lang.StringgetJavaEncodingName()intgetMaxBytesPerChar()booleanisFirebirdOnly()Can (or should) this encoding be used for reverse mapping from Java to Firebird.booleanisInformationOnly()Can this implementation create anEncodinginstance, or does it provide information only (eg about unsupported character sets)java.lang.StringtoString()
 
- 
- 
- 
Constructor Detail- 
DefaultEncodingDefinitionpublic DefaultEncodingDefinition(java.lang.String firebirdEncodingName, java.nio.charset.Charset charset, int maxBytesPerChar, int firebirdCharacterSetId, boolean firebirdOnly)Initializes an instance of DefaultEncodingDefinition.- Parameters:
- firebirdEncodingName- Name of the Firebird encoding
- charset- Java- Charsetinstance (- nullfor information-only instances)
- maxBytesPerChar- Maximum number of bytes per character (eg 1 for ISO8859_1, 4 for UTF8, 3 for UNICODE-FSS)
- firebirdCharacterSetId- Firebird character set id
- firebirdOnly- Mapping only applies from Firebird to Java, but not from Java to Firebird (eg Firebird UNICODE-FSS maps to Java UTF-8, but Java UTF-8 does not map to Firebird UNICODE-FSS (but to Firebird UTF8)
 
 - 
DefaultEncodingDefinitionpublic DefaultEncodingDefinition(java.lang.String firebirdEncodingName, java.lang.String charsetName, int maxBytesPerChar, int firebirdCharacterSetId, boolean firebirdOnly)Initializes an instance of DefaultEncodingDefinition.The actual Java character set is loaded on-demand. If the provided name cannot be resolved to a Charsetat on-demand load time, it will be handled as information-only.- Parameters:
- firebirdEncodingName- Name of the Firebird encoding
- charsetName- Java character set name, or- nullfor information-only instances
- maxBytesPerChar- Maximum number of bytes per character (eg 1 for ISO8859_1, 4 for UTF8, 3 for UNICODE-FSS)
- firebirdCharacterSetId- Firebird character set id
- firebirdOnly- Mapping only applies from Firebird to Java, but not from Java to Firebird (eg Firebird UNICODE-FSS maps to Java UTF-8, but Java UTF-8 does not map to Firebird UNICODE-FSS (but to Firebird UTF8)
 
 
- 
 - 
Method Detail- 
getMaxBytesPerCharpublic int getMaxBytesPerChar() - Specified by:
- getMaxBytesPerCharin interface- EncodingDefinition
- Returns:
- Maximum number of bytes per character.
 
 - 
getJavaEncodingNamepublic java.lang.String getJavaEncodingName() - Specified by:
- getJavaEncodingNamein interface- EncodingDefinition
- Returns:
- Java name of the encoding
 
 - 
getJavaCharsetpublic java.nio.charset.Charset getJavaCharset() - Specified by:
- getJavaCharsetin interface- EncodingDefinition
- Returns:
- Java Charsetfor this encoding
 
 - 
getFirebirdEncodingNamepublic java.lang.String getFirebirdEncodingName() - Specified by:
- getFirebirdEncodingNamein interface- EncodingDefinition
- Returns:
- Firebird name of the encoding
 
 - 
getFirebirdCharacterSetIdpublic int getFirebirdCharacterSetId() - Specified by:
- getFirebirdCharacterSetIdin interface- EncodingDefinition
- Returns:
- Firebird id of the encoding
 
 - 
isFirebirdOnlypublic boolean isFirebirdOnly() Description copied from interface:EncodingDefinitionCan (or should) this encoding be used for reverse mapping from Java to Firebird.The best example of this is the Firebird character set UNICODE-FSSwhich maps to the Java character setUTF-8, but when Java character setUTF-8is requested, Jaybird should (in general) map to Firebird character setUTF8.- Specified by:
- isFirebirdOnlyin interface- EncodingDefinition
- Returns:
- truewhen this encoding maps from Java to Firebird,- falseotherwise
 
 - 
isInformationOnlypublic boolean isInformationOnly() Description copied from interface:EncodingDefinitionCan this implementation create anEncodinginstance, or does it provide information only (eg about unsupported character sets)- Specified by:
- isInformationOnlyin interface- EncodingDefinition
- Returns:
- trueif this EncodingDefinition only provides information, and is not capable of building a concrete implementation.
 
 - 
getEncodingpublic Encoding getEncoding() Returns theEncodinginstance for this definition. The same object is returned each time this method is called.- Specified by:
- getEncodingin interface- EncodingDefinition
- Returns:
- Encoding object or nullif this is an information only EncodingDefinition
- See Also:
- EncodingDefinition.isInformationOnly()
 
 - 
toStringpublic java.lang.String toString() - Overrides:
- toStringin class- java.lang.Object
 
 
- 
 
-