com.optimaize.langdetect

Class DetectedLanguage

java.lang.Object

com.optimaize.langdetect.DetectedLanguage

All Implemented Interfaces:

Comparable<DetectedLanguage>

public class DetectedLanguage
extends Object
implements Comparable<DetectedLanguage>

Holds information about a detected language: the locale (language) and the probability.

Comparable: the "better" one comes before the worse. First order by probability descending (1 to 0). Then order by language ascending (a to z).

This class is immutable.

Author:

Nakatani Shuyo, Fabian Kessler

Constructor Summary

Constructors

Constructor and Description
DetectedLanguage(LdLocale locale, double probability)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(DetectedLanguage o) See class header.
LdLocale	getLocale()
double	getProbability()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DetectedLanguage

public DetectedLanguage(@NotNull
                LdLocale locale,
                double probability)

Parameters:

locale -

probability - 0-1

Method Detail

getLocale

@NotNull
public LdLocale getLocale()

getProbability

public double getProbability()

Returns:

0-1, the higher the better.

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(DetectedLanguage o)

See class header.

Specified by:

compareTo in interface Comparable<DetectedLanguage>