Revision: 7785
http://languagetool.svn.sourceforge.net/languagetool/?rev=7785&view=rev
Author: dnaber
Date: 2012-08-04 15:28:13 +0000 (Sat, 04 Aug 2012)
Log Message:
-----------
fix documentation
Modified Paths:
--------------
trunk/JLanguageTool/src/java/org/languagetool/databroker/DefaultResourceDataBroker.java
trunk/JLanguageTool/src/java/org/languagetool/databroker/ResourceDataBroker.java
Modified:
trunk/JLanguageTool/src/java/org/languagetool/databroker/DefaultResourceDataBroker.java
===================================================================
---
trunk/JLanguageTool/src/java/org/languagetool/databroker/DefaultResourceDataBroker.java
2012-08-03 17:10:01 UTC (rev 7784)
+++
trunk/JLanguageTool/src/java/org/languagetool/databroker/DefaultResourceDataBroker.java
2012-08-04 15:28:13 UTC (rev 7785)
@@ -131,8 +131,8 @@
* directory. Please start your path information with {@code /}
* because it will be concatenated with the directory's name:
* /resource<b>/yourpath</b>.
- * @return An {@link InputStream} object to the requested item or {@code
- * null} if it wasn't found.
+ * @return An {@link InputStream} object to the requested item
+ * @throws RuntimeException if path cannot be found
*/
@Override
public InputStream getFromResourceDirAsStream(final String path) {
@@ -151,8 +151,8 @@
* directory. Please start your path information with {@code /}
* because it will be concatenated with the directory's name:
* /resource<b>/yourpath</b>.
- * @return An {@link URL} object to the requested item or {@code null} if it
- * wasn't found.
+ * @return An {@link URL} object to the requested item
+ * @throws RuntimeException if path cannot be found
*/
@Override
public URL getFromResourceDirAsUrl(final String path) {
@@ -198,8 +198,8 @@
* directory. Please start your path information with {@code /}
* because it will be concatenated with the directory's name:
* /rules<b>/yourpath</b>.
- * @return An {@link InputStream} object to the requested item or {@code
- * null} if it wasn't found.
+ * @return An {@link InputStream} object to the requested item
+ * @throws RuntimeException if path cannot be found
*/
@Override
public InputStream getFromRulesDirAsStream(final String path) {
@@ -217,8 +217,8 @@
* directory. Please start your path information with {@code /}
* because it will be concatenated with the directory's name:
* /rules<b>/yourpath</b>.
- * @return An {@link URL} object to the requested item or {@code null} if it
- * wasn't found.
+ * @return An {@link URL} object to the requested item
+ * @throws RuntimeException if path cannot be found
*/
@Override
public URL getFromRulesDirAsUrl(final String path) {
Modified:
trunk/JLanguageTool/src/java/org/languagetool/databroker/ResourceDataBroker.java
===================================================================
---
trunk/JLanguageTool/src/java/org/languagetool/databroker/ResourceDataBroker.java
2012-08-03 17:10:01 UTC (rev 7784)
+++
trunk/JLanguageTool/src/java/org/languagetool/databroker/ResourceDataBroker.java
2012-08-04 15:28:13 UTC (rev 7785)
@@ -70,8 +70,8 @@
* 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.
+ * @return An {@link URL} object to the requested item
+ * @throws RuntimeException if path cannot be found
*/
public URL getFromResourceDirAsUrl(String path);
@@ -93,8 +93,8 @@
* 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.
+ * @return An {@link InputStream} object to the requested item
+ * @throws RuntimeException if path cannot be found
*/
public InputStream getFromResourceDirAsStream(String path);
@@ -103,8 +103,8 @@
*
* @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.
+ * @return An {@link URL} object to the requested item
+ * @throws RuntimeException if path cannot be found
*/
public URL getFromRulesDirAsUrl(String path);
@@ -112,8 +112,8 @@
* 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.
+ * @return An {@link InputStream} object to the requested item
+ * @throws RuntimeException if path cannot be found
*/
public InputStream getFromRulesDirAsStream(String path);
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Languagetool-cvs mailing list
Languagetool-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/languagetool-cvs
