org.languagetool.DetectedLanguage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of languagetool-core Show documentation

LanguageTool is an Open Source proofreading software for English, French, German, Polish, Romanian, and more than 20 other languages. It finds many errors that a simple spell checker cannot detect like mixing up there/their and it detects some grammar problems.

There is a newer version: 6.5

Show newest version

/* LanguageTool, a natural language style checker
 * Copyright (C) 2018 Daniel Naber (http://www.danielnaber.de)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 *
 */
package org.languagetool;

import org.jetbrains.annotations.Nullable;

/**
 * @since 4.2
 */
public class DetectedLanguage {

  private final Language givenLanguage;
  private final Language detectedLanguage;
  private final float detectionConfidence;
  private final String detectionSource;

  public DetectedLanguage(Language givenLanguage, Language detectedLanguage) {
    this(givenLanguage, detectedLanguage, 1.0f, null);
  }

  /**
   * @since 4.4
   */
  public DetectedLanguage(Language givenLanguage, Language detectedLanguage, float detectionConfidence, String detectionSource) {
    this.givenLanguage = givenLanguage;
    this.detectedLanguage = detectedLanguage;
    this.detectionConfidence = detectionConfidence;
    this.detectionSource = detectionSource;
  }

  public Language getGivenLanguage() {
    return givenLanguage;
  }

  public Language getDetectedLanguage() {
    return detectedLanguage;
  }

  /**
   * @since 4.4
   */
  public float getDetectionConfidence() {
    return detectionConfidence;
  }

  @Nullable
  public String getDetectionSource() {
    return detectionSource;
  }

  @Override
  public String toString() {
    return detectedLanguage.getShortCodeWithCountryAndVariant();
  }
}