opennlp.tools.langdetect.LanguageDetector Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package opennlp.tools.langdetect;
import java.io.Serializable;
/**
* The interface for {@link LanguageDetector} which predicts the {@link Language} for a context.
*/
public interface LanguageDetector extends Serializable {
/**
* Predicts the {@link Language languages} for the full {@code content} length.
*
* @param content The textual content to detect potential {@link Language languages} from.
* @return the predicted languages
*/
Language[] predictLanguages(CharSequence content);
/**
* Predicts the {@link Language} for the full {@code content} length.
*
* @param content The textual content to detect potential {@link Language languages} from.
* @return the language with the highest confidence
*/
Language predictLanguage(CharSequence content);
/**
* @return Retrieves an array of language (codes) that are supported by a {@link LanguageDetector}.
*/
String[] getSupportedLanguages();
}