- All Known Implementing Classes:
EncodingFactory
Note on naming convention: normally the prefix I
for interfaces is avoided in Java, in this particular
case I decided to use it as the concrete class EncodingFactory
is the actual factory and the main access for
encoding related information. This interface is used for connection specific factories (e.g. so the defaultEncoding
is the connection character set).
- Since:
- 3.0
- Author:
- Mark Rotteveel
-
Method Summary
Modifier and TypeMethodDescriptionReturns theEncodingDefinition
for the default platform character set.getEncodingDefinition
(String firebirdEncodingName, String javaCharsetAlias) Gets or creates anEncodingDefinition
for the supplied Firebird encoding and Java charset.getEncodingDefinitionByCharacterSetId
(int firebirdCharacterSetId) Looks up theEncodingDefinition
for the specified Firebird character set id.getEncodingDefinitionByCharset
(Charset charset) Looks up anEncodingDefinition
for the JavaCharset
.getEncodingDefinitionByCharsetAlias
(String charsetAlias) Looks up theEncodingDefinition
by the specified Java character set name or alias.getEncodingDefinitionByFirebirdName
(String firebirdEncodingName) Looks up theEncodingDefinition
for the specified Firebird encoding name.getEncodingForCharacterSetId
(int firebirdCharacterSetId) Gets anEncoding
for the specified Firebird character set id.getEncodingForCharset
(Charset charset) Gets anEncoding
for the specified Java character set.getEncodingForCharset
(Charset charset, Encoding fallbackEncoding) Gets anEncoding
for the specified Java character set.getEncodingForCharsetAlias
(String charsetAlias) Gets anEncoding
for the specified Java character set name or alias.getEncodingForFirebirdName
(String firebirdEncodingName) Gets anEncoding
for the specified Firebird encoding.<T extends DatatypeCoder>
TgetOrCreateDatatypeCoder
(Class<T> datatypeCoderClass, Function<IEncodingFactory, T> datatypeCoderFactory) Gets or - if necessary - creates a datatype coder of the specified type.getOrCreateEncodingForCharset
(Charset charset) Creates anEncoding
for the specified Java character set.withDefaultEncodingDefinition
(Charset charset) withDefaultEncodingDefinition
(EncodingDefinition encodingDefinition) Returns anIEncodingFactory
that usesencodingDefinition
as the default.
-
Method Details
-
getDefaultEncoding
Encoding getDefaultEncoding()- Returns:
- The
Encoding
forCharset.defaultCharset()
.
-
getDefaultEncodingDefinition
EncodingDefinition getDefaultEncodingDefinition()Returns theEncodingDefinition
for 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"
.- Returns:
- The
EncodingDefinition
forCharset.defaultCharset()
.
-
getEncodingDefinitionByFirebirdName
Looks up theEncodingDefinition
for the specified Firebird encoding name.- Parameters:
firebirdEncodingName
- The Firebird encoding name (case-insensitive)- Returns:
- EncodingDefinition instance or
null
if the encoding name is unknown
-
getEncodingForFirebirdName
Gets anEncoding
for 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.- Parameters:
firebirdEncodingName
- The Firebird encoding name (case-insensitive)- Returns:
- Encoding instance (never null)
-
getEncodingDefinitionByCharacterSetId
Looks up theEncodingDefinition
for the specified Firebird character set id.Implementations that do not know the connection character set should return
null
for the valueISCConstants.CS_dynamic
(= 127), as that is the indicator to use the connection character set.- Parameters:
firebirdCharacterSetId
- Firebird character set id- Returns:
- EncodingDefinition instance or
null
if the character set id is unknown or127
and this implementation doesn't know the connection character set.
-
getEncodingForCharacterSetId
Gets anEncoding
for 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 defaultEncoding will be used.- Parameters:
firebirdCharacterSetId
- The Firebird character set id- Returns:
- Encoding instance (never null)
-
getEncodingDefinitionByCharset
Looks up anEncodingDefinition
for the JavaCharset
.- Parameters:
charset
- The Java character set- Returns:
- EncodingDefinition instance or
null
if the character set is not mapped
-
getEncodingForCharset
Gets anEncoding
for 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.- 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:
-
getEncodingForCharset
Gets anEncoding
for 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.- Parameters:
charset
- The Java character set- Returns:
- Encoding instance (never null)
-
getOrCreateEncodingForCharset
Creates anEncoding
for 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
getEncodingForCharset(java.nio.charset.Charset, Encoding)
should be used.Don't confuse this method with
getEncodingForCharset(Charset)
, which falls back to the default encoding.- Parameters:
charset
- The Java character set- Returns:
- Encoding instance (never null)
- See Also:
-
getEncodingDefinitionByCharsetAlias
Looks up theEncodingDefinition
by the specified Java character set name or alias.- Parameters:
charsetAlias
- Name (or alias) of the Java character set (case-insensitive)- Returns:
- EncodingDefinition instance or
null
if the character set name is not mapped
-
getEncodingForCharsetAlias
Gets anEncoding
for 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.- Parameters:
charsetAlias
- The Java character set name or alias- Returns:
- Encoding instance (never null)
-
getEncodingDefinition
Gets or creates anEncodingDefinition
for the supplied Firebird encoding and Java charset.When
firebirdEncodingName
is not null andjavaCharsetAlias
is null, then the encoding definition as returned bygetEncodingDefinitionByFirebirdName(String)
is returned. For the reverse (firebirdEncodingName
is null andjavaCharsetAlias
isn't), the encoding definition as returned bygetEncodingDefinitionByCharsetAlias(String)
is returned.When both parameters are set, the result of
getEncodingDefinitionByFirebirdName(String)
is returned if the character set matches, otherwise a newDefaultEncodingDefinition
is 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.- 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
Returns anIEncodingFactory
that usesencodingDefinition
as the default.- Parameters:
encodingDefinition
- The default encoding to use (ornull
for the value ofgetDefaultEncoding()
- Returns:
- IEncodingFactory instance with the specified default.
-
withDefaultEncodingDefinition
- Parameters:
charset
- The default charset to use.- Returns:
- IEncodingFactory instance with the specified default.
-
getOrCreateDatatypeCoder
<T extends DatatypeCoder> T getOrCreateDatatypeCoder(Class<T> datatypeCoderClass, Function<IEncodingFactory, T> datatypeCoderFactory) Gets 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.
- Type Parameters:
T
- type parameter of typeDatatypeCoder
- Parameters:
datatypeCoderClass
- type of datatype coderdatatypeCoderFactory
- function for creating the datatype coder if it doesn't already exist- Returns:
- New or cached instance of datatype coder
- Since:
- 6
-