From 9988c426f1c0a798a4373e2e755cb010d14ae12e Mon Sep 17 00:00:00 2001 From: Robert von Burg Date: Mon, 25 May 2015 22:22:48 +0200 Subject: [PATCH] [Minor] added more JavaDoc to StrolchTransaction.findElement() --- .../java/li/strolch/persistence/api/StrolchTransaction.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git 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 index 2e1d51828..dace3d9ed 100644 --- 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