1 files changed, 139 insertions, 0 deletions
diff --git a/JLanguageTool/src/java/de/danielnaber/languagetool/databroker/ResourceDataBroker.java b/JLanguageTool/src/java/de/danielnaber/languagetool/databroker/ResourceDataBroker.java
new file mode 100644
index 0000000..eac263b
--- /dev/null
+++ b/JLanguageTool/src/java/de/danielnaber/languagetool/databroker/ResourceDataBroker.java
@@ -0,0 +1,139 @@
+/* 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 de.danielnaber.languagetool.databroker;
+
+import java.io.InputStream;
+import java.net.URL;
+
+import de.danielnaber.languagetool.JLanguageTool;
+
+/**
+ * Is responsible for getting the necessary resources for the grammar checker
+ * library. Following directories are currently needed by a couple of classes:
+ * 
+ * <ul style="list-type: circle">
+ * <li>{@code /resource}</li>
+ * <li>{@code /rules}</li>
+ * </ul>
+ * 
+ * This interface determines methods to obtain any contents from these
+ * directories.
+ * <p>
+ * 
+ * Make sure that you never obtain any grammar checker 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.
+ * <p>
+ * 
+ * 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.
+	 */
+	public static final String RESOURCE_DIR = "/resource";
+
+	/**
+	 * The directory name of the {@code /rules} directory.
+	 */
+	public static final String RULES_DIR = "/rules";
+
+	/**
+	 * Gets any resource from the grammar checker's {@code /resource} directory.
+	 * 
+	 * @param path Path to an item from the {@code /resource} directory.
+	 * @return An {@link URL} object to the requested item or {@code null} if it
+	 *         wasn't found.
+	 */
+	public URL getFromResourceDirAsUrl(String path);
+
+	/**
+	 * Gets any resource from the grammar checker's {@code /resource} directory.
+	 * 
+	 * @param path Path to an item from the {@code /resource} directory.
+	 * @return An {@link InputStream} object to the requested item or {@code null}
+	 *         if it wasn't found.
+	 */
+	public InputStream getFromResourceDirAsStream(String path);
+
+	/**
+	 * Gets any resource from the grammar checker's {@code /rules} directory.
+	 * 
+	 * @param path
+	 *            Path to an item from the {@code /rules} directory.
+	 * @return An {@link URL} object to the requested item or {@code null} if it
+	 *         wasn't found.
+	 */
+	public URL getFromRulesDirAsUrl(String path);
+
+	/**
+	 * Gets any resource from the grammar checker's {@code /rules} directory.
+	 * 
+	 * @param path Path to an item from the {@code /rules} directory.
+	 * @return An {@link InputStream} object to the requested item or {@code
+	 *         null} if it wasn't found.
+	 */
+	public 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:
+	 *         <p>
+	 *         {@code /subdir/furtherdir/resourcedir}
+	 */
+	public String getResourceDir();
+
+	/**
+	 * @param resourceDir The used directory path to the {@code /resource} directory.
+	 *            Make sure that you comply with the following format when setting
+	 *            this value:
+	 *            <p>
+	 *            {@code /subdir/furtherdir/resourcedir}
+	 */
+	public void setResourceDir(String resourceDir);
+
+	/**
+	 * @return The currently set rules directory path as a string. Make sure
+	 *         that you comply with the following format when setting this value:
+	 *         <p>
+	 *         {@code /subdir/furtherdir/rulesdir}
+	 */
+	public String getRulesDir();
+
+	/**
+	 * @param rulesDir The used directory path to the {@code /rules} directory. Make
+	 *            sure that you comply with the following format when setting this
+	 *            value:
+	 *            <p>
+	 *            {@code /subdir/furtherdir/rulesdir}
+	 */
+	public void setRulesDir(String rulesDir);
+}