Added javadoc example.

1 files changed, 8 insertions, 0 deletions

diff --git a/src/main/java/com/amazon/carbonado/filter/Filter.java b/src/main/java/com/amazon/carbonado/filter/Filter.java
index be70ff1..aaf00f6 100644
--- a/src/main/java/com/amazon/carbonado/filter/Filter.java
+++ b/src/main/java/com/amazon/carbonado/filter/Filter.java
@@ -595,6 +595,14 @@ public abstract class Filter<S extends Storable> implements Appender {
      * "homeAddress" which joins to Address. An Address filter, "city = ?", as

      * joined from Person's "homeAddress", becomes "homeAddress.city = ?".

      *

+     * <pre>

+     * Filter&lt;Address&gt; addressFilter = Filter.filterFor(Address.class, "city = ?");

+     * Filter&lt;Person&gt; personFilter = addressFilter.asJoinedFrom(Person.class, "homeAddress");

+     *

+     * // Equivalent filter:

+     * Filter&lt;Person&gt; personFilter2 = Filter.filterFor(Person.class, "homeAddress.city = ?");

+     * </pre>

+     *

      * @param type type of T which contains join property

      * @param joinProperty property of T which joins to this Filter's Storable type

      * @return filter for type T