org.languagetool.broker.ResourceDataBroker Maven / Gradle / Ivy
Show all versions of languagetool-core Show documentation
/* LanguageTool, a natural language style checker
* Copyright (C) 2006 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.broker;
import org.languagetool.JLanguageTool;
import java.io.InputStream;
import java.net.URL;
import java.util.*;
/**
* Is responsible for getting the necessary resources for the LanguageTool
* library. Following directories are currently needed by a couple of classes:
*
*
* - {@code /resource}
* - {@code /rules}
*
*
* This interface determines methods to obtain any contents from these
* directories.
*
*
* Make sure that you never obtain any LanguageTool resources by calling
* {@code Object.class.getResource(String)} or {@code
* Object.class.getResourceAsStream(String)} directly. If you would like to
* obtain something from these directories do always use
* {@link JLanguageTool#getDataBroker()} which provides proper methods for
* reading the directories above.
*
*
* For example, if you want to get the {@link URL} of {@code
* /rules/de/grammar.xml} just invoke
* {@link ResourceDataBroker#getFromRulesDirAsUrl(String)} and pass {@code
* /de/grammar.xml} as a string. Note: The {@code /rules} directory's name isn't
* passed, because its name might have changed. The same usage does apply for the
* {@code /resource} directory.
*
* @author PAX
* @since 1.0.1
*/
public interface ResourceDataBroker {
/**
* The directory name of the {@code /resource} directory.
*/
String RESOURCE_DIR = "/org/languagetool/resource";
/**
* The directory name of the {@code /rules} directory.
*/
String RULES_DIR = "/org/languagetool/rules";
/**
* Gets any resource from LanguageTool's {@code /resource} directory.
* @param path Path to an item from the {@code /resource} directory.
* @return An {@link URL} object to the requested item
* @throws RuntimeException if path cannot be found
*/
URL getFromResourceDirAsUrl(String path);
/**
* Gets all resources in a form of URL from LanguageTool's {@code /resource}
* directory with the same {@code path}.
* @param path Path to an items from the {@code /resource} directory.
* @return A list of {@link URL} objects to the requested item
* @throws RuntimeException if path cannot be found
*/
List getFromResourceDirAsUrls(String path);
/**
* Checks if a resource in LanguageTool's {@code /resource} exists.
* @param path Path to an item from the {@code /resource} directory.
* @return {@code true} if the resource file exists.
*/
boolean resourceExists(String path);
/**
* Checks if a resource in LanguageTool's {@code /rules} exists.
* @param path Path to an item from the {@code /rules} directory.
* @return {@code true} if the resource file exists.
*/
boolean ruleFileExists(String path);
/**
* Gets any resource from LanguageTool's {@code /resource} directory.
* @param path Path to an item from the {@code /resource} directory.
* @return An {@link InputStream} object to the requested item
* @throws RuntimeException if path cannot be found
*/
InputStream getFromResourceDirAsStream(String path);
/**
* Gets any resource from the {@code /resource} directory.
* @param path The relative path to the item inside of the {@code /resource}, e.g. {@code /xx/filename}
* @return An list of strings, one per line
* @throws RuntimeException if path cannot be found
* @since 4.9
*/
List getFromResourceDirAsLines(String path);
/**
* Get from resource broker by a path file
* @param path Path to an item
* @return An {@link InputStream} object to the requested item
* @since 4.9
*/
InputStream getAsStream(String path);
/**
* Get from resource broker by a path file
* @param path Path to an item
* @return An {@link URL} object to the requested item
* @since 5.0
*/
URL getAsURL(String path);
/**
* Get URLs from resource broker by a path file
* @param path Path to an item
* @return An list of {@link URL} objects to the requested item
* @since 5.0
*/
List getAsURLs(String path);
/**
* Gets any resource from LanguageTool's {@code /rules} directory.
* @param path Path to an item from the {@code /rules} directory.
* @return An {@link URL} object to the requested item
* @throws RuntimeException if path cannot be found
*/
URL getFromRulesDirAsUrl(String path);
/**
* Gets any resource from LanguageTool's {@code /rules} directory.
* @param path Path to an item from the {@code /rules} directory.
* @return An {@link InputStream} object to the requested item
* @throws RuntimeException if path cannot be found
*/
InputStream getFromRulesDirAsStream(String path);
/**
* @return The currently set resource directory path as a string. Make sure
* that you comply with the following format when setting this value:
* {@code /subdir/furtherdir/resourcedir}
*/
String getResourceDir();
/**
* @return The currently set rules directory path as a string. Make sure
* that you comply with the following format when setting this value:
* {@code /subdir/furtherdir/rulesdir}
*/
String getRulesDir();
/**
* Gets a resource bundle using the specified base name and locale, and the caller module.
*
* @param baseName the base name of the resource bundle, a fully qualified class name
* @param locale the locale for which a resource bundle is desired
* @return a resource bundle for the given base name and locale
* @since 5.0
*/
ResourceBundle getResourceBundle(String baseName, Locale locale);
}