Package org.languagetool.databroker
Interface ResourceDataBroker
-
- All Known Implementing Classes:
DefaultResourceDataBroker
public interface ResourceDataBroker
Is responsible for getting the necessary resources for the grammar checker library. Following directories are currently needed by a couple of classes:/resource
/rules
Make sure that you never obtain any grammar checker resources by calling
Object.class.getResource(String)
orObject.class.getResourceAsStream(String)
directly. If you would like to obtain something from these directories do always useJLanguageTool.getDataBroker()
which provides proper methods for reading the directories above.For example, if you want to get the
URL
of/rules/de/grammar.xml
just invokegetFromRulesDirAsUrl(String)
and pass/de/grammar.xml
as a string. Note: The/rules
directory's name isn't passed, because its name might have changed. The same usage does apply for the/resource
directory.- Since:
- 1.0.1
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
RESOURCE_DIR
The directory name of the/resource
directory.static java.lang.String
RULES_DIR
The directory name of the/rules
directory.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.io.InputStream
getFromResourceDirAsStream(java.lang.String path)
Gets any resource from the grammar checker's/resource
directory.java.net.URL
getFromResourceDirAsUrl(java.lang.String path)
Gets any resource from the grammar checker's/resource
directory.java.io.InputStream
getFromRulesDirAsStream(java.lang.String path)
Gets any resource from the grammar checker's/rules
directory.java.net.URL
getFromRulesDirAsUrl(java.lang.String path)
Gets any resource from the grammar checker's/rules
directory.java.lang.String
getResourceDir()
java.lang.String
getRulesDir()
boolean
resourceExists(java.lang.String path)
Checks if a resource in the grammar checker's/resource
exists.boolean
ruleFileExists(java.lang.String path)
Checks if a resource in the grammar checker's/rules
exists.
-
-
-
Field Detail
-
RESOURCE_DIR
static final java.lang.String RESOURCE_DIR
The directory name of the/resource
directory.- See Also:
- Constant Field Values
-
RULES_DIR
static final java.lang.String RULES_DIR
The directory name of the/rules
directory.- See Also:
- Constant Field Values
-
-
Method Detail
-
getFromResourceDirAsUrl
java.net.URL getFromResourceDirAsUrl(java.lang.String path)
Gets any resource from the grammar checker's/resource
directory.- Parameters:
path
- Path to an item from the/resource
directory.- Returns:
- An
URL
object to the requested item - Throws:
java.lang.RuntimeException
- if path cannot be found
-
resourceExists
boolean resourceExists(java.lang.String path)
Checks if a resource in the grammar checker's/resource
exists.- Parameters:
path
- Path to an item from the/resource
directory.- Returns:
true
if the resource file exists.
-
ruleFileExists
boolean ruleFileExists(java.lang.String path)
Checks if a resource in the grammar checker's/rules
exists.- Parameters:
path
- Path to an item from the/rules
directory.- Returns:
true
if the resource file exists.
-
getFromResourceDirAsStream
java.io.InputStream getFromResourceDirAsStream(java.lang.String path)
Gets any resource from the grammar checker's/resource
directory.- Parameters:
path
- Path to an item from the/resource
directory.- Returns:
- An
InputStream
object to the requested item - Throws:
java.lang.RuntimeException
- if path cannot be found
-
getFromRulesDirAsUrl
java.net.URL getFromRulesDirAsUrl(java.lang.String path)
Gets any resource from the grammar checker's/rules
directory.- Parameters:
path
- Path to an item from the/rules
directory.- Returns:
- An
URL
object to the requested item - Throws:
java.lang.RuntimeException
- if path cannot be found
-
getFromRulesDirAsStream
java.io.InputStream getFromRulesDirAsStream(java.lang.String path)
Gets any resource from the grammar checker's/rules
directory.- Parameters:
path
- Path to an item from the/rules
directory.- Returns:
- An
InputStream
object to the requested item - Throws:
java.lang.RuntimeException
- if path cannot be found
-
getResourceDir
java.lang.String getResourceDir()
- Returns:
- The currently set resource directory path as a string. Make sure
that you comply with the following format when setting this value:
/subdir/furtherdir/resourcedir
-
getRulesDir
java.lang.String getRulesDir()
- Returns:
- The currently set rules directory path as a string. Make sure
that you comply with the following format when setting this value:
/subdir/furtherdir/rulesdir
-
-