Top Description Fields Constructors Methods
com.ibm.icu.text

public Class CharsetMatch

extends Object
implements Comparable<CharsetMatch>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Imports
java.io.ByteArrayInputStream, .IOException, .InputStream, .InputStreamReader, .Reader

This class represents a charset that has been identified by a CharsetDetector as a possible encoding for a set of input data. From an instance of this class, you can ask for a confidence level in the charset identification, or for Java Reader or String to access the original byte data in Unicode form.

Instances of this class are created only by CharsetDetectors.

Note

this class has a natural ordering that is inconsistent with equals. The natural ordering is based on the match confidence value.

ICU Status
Stable since ICU 3.4.

Field Summary

Modifier and TypeField and Description
private String
private int
private InputStream
private String
private byte[]
private int

Constructor Summary

AccessConstructor and Description
pack-priv
pack-priv
CharsetMatch(CharsetDetector det, CharsetRecognizer rec, int conf, String csName, String lang)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

a negative integer, zero, or a positive integer as the confidence level of this CharsetMatch is less than, equal to, or greater than that of the argument.
compareTo
(CharsetMatch
the CharsetMatch object to compare against.
other
)

Implements java.lang.Comparable.compareTo.

Compare to other CharsetMatch objects.
public int

Returns:

the confidence in the charset match
getConfidence
()

Get an indication of the confidence in the charset detected.

public String

Returns:

The ISO code for the language or null if the language cannot be determined.
getLanguage
()

Get the ISO code for the language of the detected charset.

public String

Returns:

The name of the charset.
getName
()

Get the name of the detected charset.

public Reader

Returns:

the Reader for the Unicode character data.
getReader
()

Create a java.io.Reader for reading the Unicode character data corresponding to the original byte data supplied to the Charset detect operation.

public String

Returns:

a String created from the converted input data.
getString
()

Create a Java String from Unicode character data corresponding to the original byte data supplied to the Charset detect operation.

public String

Returns:

a String created from the converted input data.
getString
(int
The maximum length of the String to be created when the source of the data is an input stream, or -1 for unlimited length.
maxLength
)

Create a Java String from Unicode character data corresponding to the original byte data supplied to the Charset detect operation.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

fCharsetNameback to summary
private String fCharsetName
fConfidenceback to summary
private int fConfidence
fInputStreamback to summary
private InputStream fInputStream
fLangback to summary
private String fLang
fRawInputback to summary
private byte[] fRawInput
fRawLengthback to summary
private int fRawLength

Constructor Detail

CharsetMatchback to summary
pack-priv CharsetMatch(CharsetDetector det, CharsetRecognizer rec, int conf)
CharsetMatchback to summary
pack-priv CharsetMatch(CharsetDetector det, CharsetRecognizer rec, int conf, String csName, String lang)

Method Detail

compareToback to summary
public int compareTo(CharsetMatch other)

Implements java.lang.Comparable.compareTo.

Compare to other CharsetMatch objects. Comparison is based on the match confidence value, which allows CharsetDetector.detectAll() to order its results.

Parameters
other:CharsetMatch

the CharsetMatch object to compare against.

Returns:int

a negative integer, zero, or a positive integer as the confidence level of this CharsetMatch is less than, equal to, or greater than that of the argument.

Annotations
@Override
Exceptions
ClassCastException:
if the argument is not a CharsetMatch.
ICU Status
Stable since ICU 4.4.
getConfidenceback to summary
public int getConfidence()

Get an indication of the confidence in the charset detected. Confidence values range from 0-100, with larger numbers indicating a better match of the input data to the characteristics of the charset.

Returns:int

the confidence in the charset match

ICU Status
Stable since ICU 3.4.
getLanguageback to summary
public String getLanguage()

Get the ISO code for the language of the detected charset.

Returns:String

The ISO code for the language or null if the language cannot be determined.

ICU Status
Stable since ICU 3.4.
getNameback to summary
public String getName()

Get the name of the detected charset. The name will be one that can be used with other APIs on the platform that accept charset names. It is the "Canonical name" as defined by the class java.nio.charset.Charset; for charsets that are registered with the IANA charset registry, this is the MIME-preferred registerd name.

Returns:String

The name of the charset.

ICU Status
Stable since ICU 3.4.
See Also
java.nio.charset.Charset, java.io.InputStreamReader
getReaderback to summary
public Reader getReader()

Create a java.io.Reader for reading the Unicode character data corresponding to the original byte data supplied to the Charset detect operation.

Caution

if the source of the byte data was an InputStream, a Reader can be created for only one matching char set using this method. If more than one charset needs to be tried, the caller will need to reset the InputStream and create InputStreamReaders itself, based on the charset name.

Returns:Reader

the Reader for the Unicode character data.

ICU Status
Stable since ICU 3.4.
getStringback to summary
public String getString() throws IOException

Create a Java String from Unicode character data corresponding to the original byte data supplied to the Charset detect operation.

Returns:String

a String created from the converted input data.

ICU Status
Stable since ICU 3.4.
getStringback to summary
public String getString(int maxLength) throws IOException

Create a Java String from Unicode character data corresponding to the original byte data supplied to the Charset detect operation. The length of the returned string is limited to the specified size; the string will be trunctated to this length if necessary. A limit value of zero or less is ignored, and treated as no limit.

Parameters
maxLength:int

The maximum length of the String to be created when the source of the data is an input stream, or -1 for unlimited length.

Returns:String

a String created from the converted input data.

ICU Status
Stable since ICU 3.4.