From 81683c5d2a708409f060f4f79140387be33f6fe9 Mon Sep 17 00:00:00 2001 From: Robin Bygrave Date: Mon, 20 Jul 2015 11:50:38 +1200 Subject: [PATCH] No effective change - javadoc --- .../java/com/avaje/ebean/FetchConfig.java | 72 +++++++++---------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/src/main/java/com/avaje/ebean/FetchConfig.java b/src/main/java/com/avaje/ebean/FetchConfig.java index 56a6ab6dc..b885ce3ff 100644 --- a/src/main/java/com/avaje/ebean/FetchConfig.java +++ b/src/main/java/com/avaje/ebean/FetchConfig.java @@ -22,57 +22,57 @@ import java.io.Serializable; * efficient loaded as 2 SQL queries. *

* - * 
+ * 
{@code
  * // Normal fetch join results in a single SQL query
- * List<Order> list = Ebean.find(Order.class).fetch("details").findList();
+ * List list = Ebean.find(Order.class).fetch("details").findList();
  * 
  * // Find Orders join details using a single SQL query
- * 

+ * }
*

* Example: Using a "query join" instead of a "fetch join" we instead use 2 SQL * queries *

* - * 
+ * 
{@code
  * // This will use 2 SQL queries to build this object graph
- * List<Order> list =
+ * List list =
  *     Ebean.find(Order.class)
- *         .fetch("details", new FetchConfig().query())
+ *         .fetch("details", new FetchConfig().query())
  *         .findList();
  * 
  * // query 1) find order
  * // query 2) find orderDetails where order.id in (?,?...) // first 100 order id's
- * 

+ * }
*

* Example: Using 2 "query joins" *

* - * 
+ * 
{@code
  * // This will use 3 SQL queries to build this object graph
- * List<Order> list =
+ * List list =
  *     Ebean.find(Order.class)
- *         .fetch("details", new FetchConfig().query())
- *         .fetch("customer", new FetchConfig().queryFirst(5))
+ *         .fetch("details", new FetchConfig().query())
+ *         .fetch("customer", new FetchConfig().queryFirst(5))
  *         .findList();
  * 
  * // query 1) find order
  * // query 2) find orderDetails where order.id in (?,?...) // first 100 order id's
  * // query 3) find customer where id in (?,?,?,?,?) // first 5 customers
- * 

+ * }
*

* Example: Using "query joins" and partial objects *

* - * 
+ * 
{@code
  * // This will use 3 SQL queries to build this object graph
- * List<Order> list =
+ * List list =
  *     Ebean.find(Order.class)
- *         .select("status, shipDate")
- *         .fetch("details", "quantity, price", new FetchConfig().query())
- *         .fetch("details.product", "sku, name")
- *         .fetch("customer", "name", new FetchConfig().queryFirst(5))
- *         .fetch("customer.contacts")
- *         .fetch("customer.shippingAddress")
+ *         .select("status, shipDate")
+ *         .fetch("details", "quantity, price", new FetchConfig().query())
+ *         .fetch("details.product", "sku, name")
+ *         .fetch("customer", "name", new FetchConfig().queryFirst(5))
+ *         .fetch("customer.contacts")
+ *         .fetch("customer.shippingAddress")
  *         .findList();
  * 
  * // query 1) find order (status, shipDate)
@@ -81,22 +81,22 @@ import java.io.Serializable;
  * // query 3) find customer (name) fetch contacts (*) fetch shippingAddress (*)
  * // where id in (?,?,?,?,?)
  * 
- * // Note: the fetch of "details.product" is automatically included into the
- * // fetch of "details"
+ * // Note: the fetch of "details.product" is automatically included into the
+ * // fetch of "details"
  * //
- * // Note: the fetch of "customer.contacts" and "customer.shippingAddress"
- * // are automatically included in the fetch of "customer"
- * 

+ * // Note: the fetch of "customer.contacts" and "customer.shippingAddress"
+ * // are automatically included in the fetch of "customer"
+ * }
*

* You can use query() and lazy together on a single join. The query is executed * immediately and the lazy defines the batch size to use for further lazy * loading (if lazy loading is invoked). *

* - * 
- * List<Order> list =
+ * 
{@code
+ * List list =
  *     Ebean.find(Order.class)
- *         .fetch("customer", new FetchConfig().query(10).lazy(5))
+ *         .fetch("customer", new FetchConfig().query(10).lazy(5))
  *         .findList();
  * 
  * // query 1) find order
@@ -104,7 +104,7 @@ import java.io.Serializable;
  * // .. then if lazy loading of customers is invoked
  * // .. use a batch size of 5 to load the customers
  * 
- * 

+ * }
* *

* Example of controlling the lazy loading query: @@ -114,12 +114,12 @@ import java.io.Serializable; * case. *

* - * 
- * List<Order> list = Ebean.find(Order.class)
- *   .fetch("customer","name", new FetchConfig().lazy(5))
- *   .fetch("customer.contacts","contactName, phone, email")
- *   .fetch("customer.shippingAddress")
- *   .where().eq("status",Order.Status.NEW)
+ * 
{@code
+ * List list = Ebean.find(Order.class)
+ *   .fetch("customer","name", new FetchConfig().lazy(5))
+ *   .fetch("customer.contacts","contactName, phone, email")
+ *   .fetch("customer.shippingAddress")
+ *   .where().eq("status",Order.Status.NEW)
  *   .findList();
  * 
  * // query 1) find order where status = Order.Status.NEW
@@ -132,7 +132,7 @@ import java.io.Serializable;
  *       fetch customer.shippingAddress (*) 
  *       where id in (?,?,?,?,?)
  * 
- * 

+ * }
* * @author mario * @author rbygrave