fr.sii.ogham.core.charset

Interface CharsetDetector

All Known Implementing Classes:

FixedCharsetDetector

public interface CharsetDetector

Interface for all charset detectors. A charset detector tries to detect the NIO charset used by the provided input. The charset detection is not deterministic. For a same input string, several charsets may be detected. The detector can provide the best charset or a list of possible charsets with a confidence indication.

Author:

Aurélien Baudet

Method Summary

Modifier and Type	Method and Description
Charset	detect(byte[] bytes) Detects the charset of the input bytes.
Charset	detect(InputStream stream) Detects the charset of the stream.
Charset	detect(String str) Detects the charset of the input string.
List<CharsetMatch>	detectAll(byte[] bytes) Detects all charsets that appear to be plausible matches with the input data.
List<CharsetMatch>	detectAll(InputStream stream) Detects all charsets that appear to be plausible matches with the input data.
List<CharsetMatch>	detectAll(String str) Detects all charsets that appear to be plausible matches with the input data.

Method Detail

detect

Charset detect(String str)

Detects the charset of the input string. If no charset could be determined, then null is returned. Only the best matching charset is returned.

Parameters:

str - the string to analyze

Returns:

the detected charset

detect

Charset detect(byte[] bytes)

Detects the charset of the input bytes. If no charset could be determined, then null is returned. Only the best matching charset is returned.

Parameters:

bytes - the bytes to analyze

Returns:

the detected charset

detect

Charset detect(InputStream stream)

Detects the charset of the stream. If no charset could be determined, then null is returned. Only the best matching charset is returned.

Parameters:

stream - the stream to analyze

Returns:

the detected charset

detectAll

List<CharsetMatch> detectAll(String str)

Detects all charsets that appear to be plausible matches with the input data. The list of results is ordered with the best quality match first. If no charset could be determined, then an empty list is returned.

Parameters:

str - the string to analyze

Returns:

the possible charsets with a confidence indication

detectAll

List<CharsetMatch> detectAll(byte[] bytes)

Detects all charsets that appear to be plausible matches with the input data. The list of results is ordered with the best quality match first. If no charset could be determined, then an empty list is returned.

Parameters:

bytes - the bytes to analyze

Returns:

the possible charsets with a confidence indication

detectAll

List<CharsetMatch> detectAll(InputStream stream)

Detects all charsets that appear to be plausible matches with the input data. The list of results is ordered with the best quality match first. If no charset could be determined, then an empty list is returned.

Parameters:

stream - the stream to analyze

Returns:

the possible charsets with a confidence indication