com.optimaize.langdetect.profiles

Class LanguageProfileReader

java.lang.Object

com.optimaize.langdetect.profiles.LanguageProfileReader

public class LanguageProfileReader
extends Object

Reads LanguageProfiles.

Author:

Fabian Kessler

Constructor Summary

Constructors

Constructor and Description
LanguageProfileReader()

Method Summary

Methods

Modifier and Type	Method and Description
List<LanguageProfile>	read(ClassLoader classLoader, String profileDirectory, Collection<String> profileFileNames) Load profiles from the classpath in a specific directory.
List<LanguageProfile>	read(Collection<String> profileFileNames) Same as read(ClassLoader, String, java.util.Collection) using the class loader of this class, and the default profiles directory of this library.
LanguageProfile	read(File profileFile) Reads a LanguageProfile from a File in UTF-8.
LanguageProfile	read(InputStream inputStream) Reads a LanguageProfile from an InputStream in UTF-8.
List<LanguageProfile>	read(String profileDirectory, Collection<String> profileFileNames) Same as read(ClassLoader, String, java.util.Collection) using the class loader of this class.
List<LanguageProfile>	readAll() Deprecated. renamed to readAllBuiltIn()
List<LanguageProfile>	readAll(File path) Loads all profiles from the specified directory.
List<LanguageProfile>	readAllBuiltIn() Reads all built-in language profiles from the "languages" folder (shipped with the jar).
List<LanguageProfile>	readBuiltIn(Collection<LdLocale> languages)
LanguageProfile	readBuiltIn(LdLocale locale)

Methods inherited from class java.lang.Object

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

Constructor Detail

LanguageProfileReader

public LanguageProfileReader()

Method Detail

read

public LanguageProfile read(File profileFile)
                     throws IOException

Reads a LanguageProfile from a File in UTF-8.

Throws:

IOException

read

public LanguageProfile read(InputStream inputStream)
                     throws IOException

Reads a LanguageProfile from an InputStream in UTF-8.

Throws:

IOException

read

public List<LanguageProfile> read(ClassLoader classLoader,
                         String profileDirectory,
                         Collection<String> profileFileNames)
                           throws IOException

Load profiles from the classpath in a specific directory.

This is usually used to load built-in profiles, shipped with the jar.

Parameters:

classLoader - the ClassLoader to load the profiles from. Use MyClass.class.getClassLoader()

profileDirectory - profile directory path inside the classpath. The default profiles are in "languages".

profileFileNames - for example ["en", "fr", "de"].

Throws:

IOException

read

public List<LanguageProfile> read(String profileDirectory,
                         Collection<String> profileFileNames)
                           throws IOException

Same as read(ClassLoader, String, java.util.Collection) using the class loader of this class.

Throws:

IOException

read

public List<LanguageProfile> read(Collection<String> profileFileNames)
                           throws IOException

Same as read(ClassLoader, String, java.util.Collection) using the class loader of this class, and the default profiles directory of this library.

Throws:

IOException

readBuiltIn

@NotNull
public LanguageProfile readBuiltIn(@NotNull
                                  LdLocale locale)
                            throws IOException

Throws:

IOException

readBuiltIn

@NotNull
public List<LanguageProfile> readBuiltIn(@NotNull
                                        Collection<LdLocale> languages)
                                  throws IOException

Throws:

IOException

readAll

public List<LanguageProfile> readAll()
                              throws IOException

Deprecated. renamed to readAllBuiltIn()

Throws:

IOException

readAllBuiltIn

public List<LanguageProfile> readAllBuiltIn()
                                     throws IOException

Reads all built-in language profiles from the "languages" folder (shipped with the jar).

Throws:

IOException

readAll

public List<LanguageProfile> readAll(File path)
                              throws IOException

Loads all profiles from the specified directory. Do not use this method for files distributed within a jar.

Parameters:

path - profile directory path

Returns:

empty if there is no language file in it.

Throws:

IOException