Class DefaultResourceDataBroker
- All Implemented Interfaces:
ResourceDataBroker
If you'd like to determine another resource directory location this default
data broker provides proper methods.
Assuming your /rules
and /resource
directories are accessible
via class-path with following path information:
/res/grammarchecker/rulesdirname
/res/grammarchecker/resourcedirname
/res/grammarchecker/rulesdirname
/res/grammarchecker/resourcedirname
Make sure that you never obtain any grammar checker resources by calling
Object.class.getResource(String)
or
Object.class.getResourceAsStream(String)
directly. If you would like to
obtain something from these directories do always use
JLanguageTool.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 invoke
ResourceDataBroker.getFromRulesDirAsUrl(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
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final String
The directory's name of the grammar checker's resource directory.private final String
The directory's name of the grammar checker's rules directory.Fields inherited from interface org.languagetool.databroker.ResourceDataBroker
RESOURCE_DIR, RULES_DIR
-
Constructor Summary
ConstructorsConstructorDescriptionInstantiates this data broker with the default resource directory names as specified in:ResourceDataBroker.RESOURCE_DIR
ResourceDataBroker.RULES_DIR
DefaultResourceDataBroker
(String resourceDir, String rulesDir) Instantiates this data broker with the passed resource directory names. -
Method Summary
Modifier and TypeMethodDescriptionprivate String
appendPath
(String baseDir, String path) private void
assertNotNull
(Object object, String path, String completePath) private String
getCompleteResourceUrl
(String path) Concatenates the passed resource path with the currently setresource
directory path.private String
getCompleteRulesUrl
(String path) Concatenates the passed resource path with the currently setrules
directory path.getFromRulesDirAsUrl
(String path) boolean
resourceExists
(String path) See:ResourceDataBroker.resourceExists(String)
Checks if a resource in the grammar checker's/resource
exists.boolean
ruleFileExists
(String path) See:ResourceDataBroker.ruleFileExists(String)
Checks if a resource in the grammar checker's/rules
exists.
-
Field Details
-
resourceDir
The directory's name of the grammar checker's resource directory. The default value equalsResourceDataBroker.RESOURCE_DIR
. -
rulesDir
The directory's name of the grammar checker's rules directory. The default value equalsResourceDataBroker.RULES_DIR
.
-
-
Constructor Details
-
DefaultResourceDataBroker
public DefaultResourceDataBroker()Instantiates this data broker with the default resource directory names as specified in: -
DefaultResourceDataBroker
Instantiates this data broker with the passed resource directory names.- Parameters:
resourceDir
- The directory's name of the grammar checker's resource directory. The default value equalsResourceDataBroker.RESOURCE_DIR
.rulesDir
- The directory's name of the grammar checker's rules directory. The default value equalsResourceDataBroker.RULES_DIR
.
-
-
Method Details
-
getFromResourceDirAsStream
- Specified by:
getFromResourceDirAsStream
in interfaceResourceDataBroker
- Parameters:
path
- The relative path to the item inside of the/resource
directory. Please start your path information with/
because it will be concatenated with the directory's name: /resource/yourpath.- Returns:
- An
InputStream
object to the requested item - Throws:
RuntimeException
- if path cannot be found
-
getFromResourceDirAsUrl
- Specified by:
getFromResourceDirAsUrl
in interfaceResourceDataBroker
- Parameters:
path
- The relative path to the item inside of the/resource
directory. Please start your path information with/
because it will be concatenated with the directory's name: /resource/yourpath.- Returns:
- An
URL
object to the requested item - Throws:
RuntimeException
- if path cannot be found
-
getCompleteResourceUrl
Concatenates the passed resource path with the currently setresource
directory path.- Parameters:
path
- The relative path to a resource item inside of theresource
directory.- Returns:
- The full relative path to the resource including the path to the
resource
directory.
-
getFromRulesDirAsStream
- Specified by:
getFromRulesDirAsStream
in interfaceResourceDataBroker
- Parameters:
path
- The relative path to the item inside of the/rules
directory. Please start your path information with/
because it will be concatenated with the directory's name: /rules/yourpath.- Returns:
- An
InputStream
object to the requested item - Throws:
RuntimeException
- if path cannot be found
-
getFromRulesDirAsUrl
- Specified by:
getFromRulesDirAsUrl
in interfaceResourceDataBroker
- Parameters:
path
- The relative path to the item inside of the/rules
directory. Please start your path information with/
because it will be concatenated with the directory's name: /rules/yourpath.- Returns:
- An
URL
object to the requested item - Throws:
RuntimeException
- if path cannot be found
-
assertNotNull
-
getCompleteRulesUrl
Concatenates the passed resource path with the currently setrules
directory path.- Parameters:
path
- The relative path to a resource item inside of therules
directory.- Returns:
- The full relative path to the resource including the path to the
rules
directory.
-
appendPath
-
resourceExists
See:ResourceDataBroker.resourceExists(String)
Checks if a resource in the grammar checker's/resource
exists.- Specified by:
resourceExists
in interfaceResourceDataBroker
- Parameters:
path
- Path to an item from the/resource
directory.- Returns:
true
if the resource file exists.
-
ruleFileExists
See:ResourceDataBroker.ruleFileExists(String)
Checks if a resource in the grammar checker's/rules
exists.- Specified by:
ruleFileExists
in interfaceResourceDataBroker
- Parameters:
path
- Path to an item from the/rules
directory.- Returns:
true
if the resource file exists.
-
getResourceDir
- Specified by:
getResourceDir
in interfaceResourceDataBroker
- Returns:
- The directory's name of the grammar checker's resource directory.
The default value equals
ResourceDataBroker.RESOURCE_DIR
.
-
getRulesDir
- Specified by:
getRulesDir
in interfaceResourceDataBroker
- Returns:
- The directory's name of the grammar checker's rules directory.
The default value equals
ResourceDataBroker.RULES_DIR
.
-