Class EncodingFactory
- java.lang.Object
-
- org.firebirdsql.encodings.EncodingFactory
-
- All Implemented Interfaces:
IEncodingFactory
public final class EncodingFactory extends java.lang.Object implements IEncodingFactory
Factory forEncodingDefinitionandEncoding.- Author:
- Mark Rotteveel
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringENCODING_NAME_NONEstatic java.lang.StringENCODING_NAME_OCTETS
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static IEncodingFactorycreateInstance(java.nio.charset.Charset charset)static IEncodingFactorycreateInstance(EncodingDefinition encodingDefinition)Returns anIEncodingFactorythat usesencodingDefinitionas the default.static EncodingFactorycreateInstance(EncodingSet... encodingSets)Creates a new EncodingFactory based on the supplied encodingSets.EncodinggetDefaultEncoding()EncodingDefinitiongetDefaultEncodingDefinition()Returns theEncodingDefinitionfor the default platform character set.EncodingDefinitiongetEncodingDefinition(java.lang.String firebirdEncodingName, java.lang.String javaCharsetAlias)Gets or creates anEncodingDefinitionfor the supplied Firebird encoding and Java charset.EncodingDefinitiongetEncodingDefinitionByCharacterSetId(int firebirdCharacterSetId)Looks up theEncodingDefinitionfor the specified Firebird character set id.EncodingDefinitiongetEncodingDefinitionByCharset(java.nio.charset.Charset charset)Looks up anEncodingDefinitionfor the JavaCharset.EncodingDefinitiongetEncodingDefinitionByCharsetAlias(java.lang.String charsetAlias)Looks up theEncodingDefinitionby the specified Java character set name or alias.EncodingDefinitiongetEncodingDefinitionByFirebirdName(java.lang.String firebirdEncodingName)Looks up theEncodingDefinitionfor the specified Firebird encoding name.EncodinggetEncodingForCharacterSetId(int firebirdCharacterSetId)Gets anEncodingfor the specified Firebird character set id.EncodinggetEncodingForCharacterSetId(int firebirdCharacterSetId, Encoding fallbackEncoding)Gets anEncodingfor the specified Firebird character set id.EncodinggetEncodingForCharset(java.nio.charset.Charset charset)Gets anEncodingfor the specified Java character set.EncodinggetEncodingForCharset(java.nio.charset.Charset charset, Encoding fallbackEncoding)Gets anEncodingfor the specified Java character set.EncodinggetEncodingForCharsetAlias(java.lang.String charsetAlias)Gets anEncodingfor the specified Java character set name or alias.EncodinggetEncodingForCharsetAlias(java.lang.String charsetAlias, Encoding fallbackEncoding)Gets anEncodingfor the specified Java character set name or alias.EncodinggetEncodingForFirebirdName(java.lang.String firebirdEncodingName)Gets anEncodingfor the specified Firebird encoding.EncodinggetEncodingForFirebirdName(java.lang.String firebirdEncodingName, Encoding fallbackEncoding)Gets anEncodingfor the specified Firebird encoding.<T extends DatatypeCoder>
TgetOrCreateDatatypeCoder(java.lang.Class<T> datatypeCoderClass)Gets or - if necessary - creates a datatype coder of the specified type.EncodinggetOrCreateEncodingForCharset(java.nio.charset.Charset charset)Creates anEncodingfor the specified Java character set.static IEncodingFactorygetPlatformDefault()Returns an instance ofIEncodingFactorywith the default encoding set to the platform encoding.static EncodinggetPlatformEncoding()IEncodingFactorywithDefaultEncodingDefinition()Returns anConnectionEncodingFactorythat usesgetDefaultEncodingDefinition()as the default.IEncodingFactorywithDefaultEncodingDefinition(java.nio.charset.Charset charset)IEncodingFactorywithDefaultEncodingDefinition(EncodingDefinition encodingDefinition)Returns anIEncodingFactorythat usesencodingDefinitionas the default.
-
-
-
Field Detail
-
ENCODING_NAME_NONE
public static final java.lang.String ENCODING_NAME_NONE
- See Also:
- Constant Field Values
-
ENCODING_NAME_OCTETS
public static final java.lang.String ENCODING_NAME_OCTETS
- See Also:
- Constant Field Values
-
-
Method Detail
-
getDefaultEncoding
public Encoding getDefaultEncoding()
- Specified by:
getDefaultEncodingin interfaceIEncodingFactory- Returns:
- The
EncodingforCharset.defaultCharset().
-
getPlatformEncoding
public static Encoding getPlatformEncoding()
- Returns:
- The default encoding of the platform.
-
getDefaultEncodingDefinition
public EncodingDefinition getDefaultEncodingDefinition()
Description copied from interface:IEncodingFactoryReturns theEncodingDefinitionfor the default platform character set.If the default character set is not supported by Jaybird, an instance of EncodingDefinition should be returned with Firebird encoding name
"NONE".- Specified by:
getDefaultEncodingDefinitionin interfaceIEncodingFactory- Returns:
- The
EncodingDefinitionforCharset.defaultCharset().
-
getEncodingDefinitionByFirebirdName
public EncodingDefinition getEncodingDefinitionByFirebirdName(java.lang.String firebirdEncodingName)
Description copied from interface:IEncodingFactoryLooks up theEncodingDefinitionfor the specified Firebird encoding name.- Specified by:
getEncodingDefinitionByFirebirdNamein interfaceIEncodingFactory- Parameters:
firebirdEncodingName- The Firebird encoding name (case-insensitive)- Returns:
- EncodingDefinition instance or
nullif the encoding name is unknown
-
getEncodingForFirebirdName
public Encoding getEncodingForFirebirdName(java.lang.String firebirdEncodingName, Encoding fallbackEncoding)
Gets anEncodingfor the specified Firebird encoding. If there is no known encoding for this name, or the loaded EncodingDefinition is information-only, then the fallbackEncoding.- Parameters:
firebirdEncodingName- The Firebird encoding name (case-insensitive)fallbackEncoding- The Encoding to use as fallback if no encoding is found (usually the connection encoding). Ifnull, the defaultEncoding for the JVM is used.- Returns:
- Encoding instance (never null)
-
getEncodingForFirebirdName
public Encoding getEncodingForFirebirdName(java.lang.String firebirdEncodingName)
Description copied from interface:IEncodingFactoryGets anEncodingfor the specified Firebird encoding. If there is no known encoding for this name, or the loaded EncodingDefinition is information-only, then the defaultEncoding is used.- Specified by:
getEncodingForFirebirdNamein interfaceIEncodingFactory- Parameters:
firebirdEncodingName- The Firebird encoding name (case-insensitive)- Returns:
- Encoding instance (never null)
-
getEncodingDefinitionByCharacterSetId
public EncodingDefinition getEncodingDefinitionByCharacterSetId(int firebirdCharacterSetId)
Description copied from interface:IEncodingFactoryLooks up theEncodingDefinitionfor the specified Firebird character set id.Implementations that do not know the connection character set should return
nullfor the valueISCConstants.CS_dynamic(= 127), as that is the indicator to use the connection character set.- Specified by:
getEncodingDefinitionByCharacterSetIdin interfaceIEncodingFactory- Parameters:
firebirdCharacterSetId- Firebird character set id- Returns:
- EncodingDefinition instance or
nullif the character set id is unknown or127and this implementation doesn't know the connection character set.
-
getEncodingForCharacterSetId
public Encoding getEncodingForCharacterSetId(int firebirdCharacterSetId, Encoding fallbackEncoding)
Gets anEncodingfor the specified Firebird character set id. If there is no known encoding for this character set id (or if it is 127, seegetEncodingDefinitionByCharacterSetId(int)), or the loaded EncodingDefinition is information-only, then the fallbackEncoding will be used.- Parameters:
firebirdCharacterSetId- The Firebird character set idfallbackEncoding- The Encoding to use as fallback if no encoding is found (usually the connection encoding). Ifnull, the defaultEncoding for the JVM is used.- Returns:
- Encoding instance (never null)
-
getEncodingForCharacterSetId
public Encoding getEncodingForCharacterSetId(int firebirdCharacterSetId)
Description copied from interface:IEncodingFactoryGets anEncodingfor the specified Firebird character set id. If there is no known encoding for this character set id (or if it is 127, seeIEncodingFactory.getEncodingDefinitionByCharacterSetId(int)), or the loaded EncodingDefinition is information-only, then the defaultEncoding will be used.- Specified by:
getEncodingForCharacterSetIdin interfaceIEncodingFactory- Parameters:
firebirdCharacterSetId- The Firebird character set id- Returns:
- Encoding instance (never null)
-
getEncodingDefinitionByCharset
public EncodingDefinition getEncodingDefinitionByCharset(java.nio.charset.Charset charset)
Description copied from interface:IEncodingFactoryLooks up anEncodingDefinitionfor the JavaCharset.- Specified by:
getEncodingDefinitionByCharsetin interfaceIEncodingFactory- Parameters:
charset- The Java character set- Returns:
- EncodingDefinition instance or
nullif the character set is not mapped
-
getEncodingForCharset
public Encoding getEncodingForCharset(java.nio.charset.Charset charset, Encoding fallbackEncoding)
Description copied from interface:IEncodingFactoryGets anEncodingfor the specified Java character set. If there is no known encoding for thisCharset, or the loaded EncodingDefinition is information-only, then the fallbackEncoding will be used.- Specified by:
getEncodingForCharsetin interfaceIEncodingFactory- Parameters:
charset- The Java character setfallbackEncoding- The Encoding to use as fallback if no encoding is found (usually the connection encoding). Ifnull, the defaultEncoding for the JVM is used.- Returns:
- Encoding instance (never null)
- See Also:
IEncodingFactory.getOrCreateEncodingForCharset(java.nio.charset.Charset)
-
getEncodingForCharset
public Encoding getEncodingForCharset(java.nio.charset.Charset charset)
Description copied from interface:IEncodingFactoryGets anEncodingfor the specified Java character set. If there is no known encoding for thisCharset, or the loaded EncodingDefinition is information-only, then the defaultEncoding will be used.- Specified by:
getEncodingForCharsetin interfaceIEncodingFactory- Parameters:
charset- The Java character set- Returns:
- Encoding instance (never null)
-
getOrCreateEncodingForCharset
public Encoding getOrCreateEncodingForCharset(java.nio.charset.Charset charset)
Description copied from interface:IEncodingFactoryCreates anEncodingfor the specified Java character set. If there is no known encoding for this charset, then an Encoding instance based on the charset is returned.In general the method
IEncodingFactory.getEncodingForCharset(java.nio.charset.Charset, Encoding)should be used.Don't confuse this method with
IEncodingFactory.getEncodingForCharset(Charset), which falls back to the default encoding.- Specified by:
getOrCreateEncodingForCharsetin interfaceIEncodingFactory- Parameters:
charset- The Java character set- Returns:
- Encoding instance (never null)
- See Also:
IEncodingFactory.getEncodingForCharset(java.nio.charset.Charset, Encoding)
-
getEncodingDefinitionByCharsetAlias
public EncodingDefinition getEncodingDefinitionByCharsetAlias(java.lang.String charsetAlias)
Description copied from interface:IEncodingFactoryLooks up theEncodingDefinitionby the specified Java character set name or alias.- Specified by:
getEncodingDefinitionByCharsetAliasin interfaceIEncodingFactory- Parameters:
charsetAlias- Name (or alias) of the Java character set (case-insensitive)- Returns:
- EncodingDefinition instance or
nullif the character set name is not mapped
-
getEncodingForCharsetAlias
public Encoding getEncodingForCharsetAlias(java.lang.String charsetAlias, Encoding fallbackEncoding)
Gets anEncodingfor the specified Java character set name or alias. If there is no known encoding for this name, or the loaded EncodingDefinition is information-only, then the fallbackEncoding will be used.- Parameters:
charsetAlias- The Java character set name or aliasfallbackEncoding- The Encoding to use as fallback if no encoding is found (usually the connection encoding). Ifnull, the defaultEncoding for the JVM is used.- Returns:
- Encoding instance (never null)
-
getEncodingForCharsetAlias
public Encoding getEncodingForCharsetAlias(java.lang.String charsetAlias)
Description copied from interface:IEncodingFactoryGets anEncodingfor the specified Java character set name or alias. If there is no known encoding for this name, or the loaded EncodingDefinition is information-only, then the defaultEncoding will be used.- Specified by:
getEncodingForCharsetAliasin interfaceIEncodingFactory- Parameters:
charsetAlias- The Java character set name or alias- Returns:
- Encoding instance (never null)
-
getEncodingDefinition
public EncodingDefinition getEncodingDefinition(java.lang.String firebirdEncodingName, java.lang.String javaCharsetAlias)
Description copied from interface:IEncodingFactoryGets or creates anEncodingDefinitionfor the supplied Firebird encoding and Java charset.When
firebirdEncodingNameis not null andjavaCharsetAliasis null, then the encoding definition as returned byIEncodingFactory.getEncodingDefinitionByFirebirdName(String)is returned. For the reverse (firebirdEncodingNameis null andjavaCharsetAliasisn't), the encoding definition as returned byIEncodingFactory.getEncodingDefinitionByCharsetAlias(String)is returned.When both parameters are set, the result of
IEncodingFactory.getEncodingDefinitionByFirebirdName(String)is returned if the character set matches, otherwise a newDefaultEncodingDefinitionis created based on its information, but with the specified character set. This can be useful for attempting to fix encoding issues in Firebird.If either of the parameters cannot be resolved, to an EncodingDefinition or
Charset, or the EncodingDefinition is information-only - with the exception of Firebird encoding NONE - and no Java Charset is specified, then null is returned.- Specified by:
getEncodingDefinitionin interfaceIEncodingFactory- Parameters:
firebirdEncodingName- Name of the Firebird encoding, or null to defer decision to the java Charset aliasjavaCharsetAlias- Alias of the Java character set, or null to defer decision to the Firebird encoding- Returns:
- An EncodingDefinition or null if both parameters are null, no encoding was found or if an exception occurred.
-
withDefaultEncodingDefinition
public IEncodingFactory withDefaultEncodingDefinition(EncodingDefinition encodingDefinition)
Returns anIEncodingFactorythat usesencodingDefinitionas the default.This implementation returns an instance of
ConnectionEncodingFactory.- Specified by:
withDefaultEncodingDefinitionin interfaceIEncodingFactory- Parameters:
encodingDefinition- The default encoding to use (ornullfor the value ofIEncodingFactory.getDefaultEncoding()- Returns:
- IEncodingFactory instance with the specified default.
-
withDefaultEncodingDefinition
public IEncodingFactory withDefaultEncodingDefinition(java.nio.charset.Charset charset)
Returns anIEncodingFactorythat uses anEncodingDefinitionidentified bycharSetas the default.This implementation returns an instance of
ConnectionEncodingFactory.- Specified by:
withDefaultEncodingDefinitionin interfaceIEncodingFactory- Parameters:
charset- The default charset to use.- Returns:
- IEncodingFactory instance with the specified default.
-
getOrCreateDatatypeCoder
public <T extends DatatypeCoder> T getOrCreateDatatypeCoder(java.lang.Class<T> datatypeCoderClass)
Description copied from interface:IEncodingFactoryGets or - if necessary - creates a datatype coder of the specified type.In general this method should only be called from a static factory method on the datatype coder itself.
- Specified by:
getOrCreateDatatypeCoderin interfaceIEncodingFactory- Type Parameters:
T- Type parameter of typeDatatypeCoder- Parameters:
datatypeCoderClass- Type of datatype coder, needs to have a single-arg constructor accepting anIEncodingFactory.- Returns:
- New or cached instance of datatype coder
-
withDefaultEncodingDefinition
public IEncodingFactory withDefaultEncodingDefinition()
Returns anConnectionEncodingFactorythat usesgetDefaultEncodingDefinition()as the default.- Returns:
- IEncodingFactory instance with the specified default.
-
getPlatformDefault
public static IEncodingFactory getPlatformDefault()
Returns an instance ofIEncodingFactorywith the default encoding set to the platform encoding.- Returns:
- Instance of
IEncodingFactory.
-
createInstance
public static IEncodingFactory createInstance(EncodingDefinition encodingDefinition)
Returns anIEncodingFactorythat usesencodingDefinitionas the default.If
encodingDefinitionisnullor an information-only encoding, the implementation will return the cached instance returned bygetPlatformDefault().- Parameters:
encodingDefinition- The default encoding to use (ornullto getgetPlatformDefault()- Returns:
- IEncodingFactory instance with the specified default.
-
createInstance
public static IEncodingFactory createInstance(java.nio.charset.Charset charset)
Returns anIEncodingFactorythat uses anEncodingDefinitionidentified bycharSetas the default.If
charsetisnull, the implementation will return the cached instance return bygetPlatformDefault().- Parameters:
charset- The default charset to use, ornullforgetPlatformDefault().- Returns:
- IEncodingFactory instance with the specified default.
-
createInstance
public static EncodingFactory createInstance(EncodingSet... encodingSets)
Creates a new EncodingFactory based on the supplied encodingSets. The suppliedEncodingSetinstances are processed highest preferenceWeight first.- Parameters:
encodingSets- The EncodingSet definitions to use for the EncodingFactory instance- Returns:
- EncodingFactory instance based on the supplied encodingSets.
-
-