From 102f7ddbc7663cddf2feeb37847c63bdd5744cc1 Mon Sep 17 00:00:00 2001
From: "Brian S. O'Neill" <bronee@gmail.com>
Date: Wed, 9 Jan 2008 20:19:32 +0000
Subject: Added javadoc example.

---
 src/main/java/com/amazon/carbonado/filter/Filter.java | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src/main/java/com/amazon/carbonado')

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
-- 
cgit v1.2.3