[Minor] added more JavaDoc to StrolchTransaction.findElement()

2015-05-25 22:22:48 +02:00 · 2015-05-25 22:22:48 +02:00 · 9988c426f1
parent 3cb65a049c
commit 9988c426f1
1 changed files with 3 additions and 1 deletions
--- a/li.strolch.agent/src/main/java/li/strolch/persistence/api/StrolchTransaction.java
+++ b/li.strolch.agent/src/main/java/li/strolch/persistence/api/StrolchTransaction.java
@ -479,7 +479,9 @@ public interface StrolchTransaction extends AutoCloseable {
 	 * @param locator
 	 *            the locator defining the path to the element which is to be found
 	 * 
-	 * @return the element described by the locator
+	 * @return the element described by the locator. If {@link Locator} references an element which does not exist, i.e.
+	 *         an inexistant {@link Resource} or an inexistand {@link Parameter} on a Resource, then a
+	 *         {@link StrolchException} is thrown
 	 * 
 	 * @throws StrolchException
 	 *             if the element could not be found