svn commit: r1294457 - in /tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request: attribute/package-info.java collection/package-info.java package-info.java reflect/package-info.java render/package-info.java

[nl...@apache.org]

Author: nlebas
Date: Tue Feb 28 04:45:29 2012
New Revision: 1294457

URL: http://svn.apache.org/viewvc?rev=1294457&view=rev
Log:
Expanded the package javadoc

Modified:
    tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/attribute/package-info.java
    tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/collection/package-info.java
    tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/package-info.java
    tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/reflect/package-info.java
    tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/render/package-info.java

Modified: tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/attribute/package-info.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/attribute/package-info.java?rev=1294457&r1=1294456&r2=1294457&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/attribute/package-info.java (original)
+++ tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/attribute/package-info.java Tue Feb 28 04:45:29 2012
@@ -19,6 +19,10 @@
  * under the License.
  */
 /**
- * Contains methods to get and set attributes from different sources.
+ * Methods to get, set and remove attributes from different sources (like HTTP requests 
+ * or sessions).
+ * By implementing {@link org.apache.tiles.request.attribute.AttributeExtractor},
+ * you can use a Map from {@link org.apache.tiles.request.collection} to manipulate the
+ * attributes of another class.
  */
 package org.apache.tiles.request.attribute;

Modified: tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/collection/package-info.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/collection/package-info.java?rev=1294457&r1=1294456&r2=1294457&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/collection/package-info.java (original)
+++ tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/collection/package-info.java Tue Feb 28 04:45:29 2012
@@ -19,6 +19,18 @@
  * under the License.
  */
 /**
- * Special collections and maps for attributes.
+ * Special collections and maps for attributes (like HTTP request 
+ * or session attributes).
+ * These can be used to access another object's attributes through 
+ * a Map interface.
+ * <ul>
+ * <li> {@link org.apache.tiles.request.collection.ScopeMap} provides
+ * full get/put/remove access to the attributes.
+ * <li> {@link org.apache.tiles.request.collection.ReadOnlyEnumerationMap}
+ * provides get-only access.
+ * <li> {@link org.apache.tiles.request.collection.HeaderValuesMap}
+ * provides get-only access to a multi-valued map (typically, headers).
+ * </ul>
  */
 package org.apache.tiles.request.collection;
+

Modified: tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/package-info.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/package-info.java?rev=1294457&r1=1294456&r2=1294457&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/package-info.java (original)
+++ tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/package-info.java Tue Feb 28 04:45:29 2012
@@ -19,8 +19,28 @@
  * under the License.
  */
 /**
- * This package abstracts the concept of "request" to make it independent
- * to any technology. It collects concepts from servlets, portlets, template technologies
- * in a uniform way.
+ * This package defines the concept of "request" as the event causing a 
+ * document to be generated from a template. The process is also called
+ * "rendering the template". Typical examples are servlet requests or 
+ * portlet requests. 
+ * 
+ * This API is independent of the underlying technology, allowing the user 
+ * to deal with similarities in servlets and portlets, or various template 
+ * technologies, in a uniform way.
+ * 
+ * It is based on 3 main interfaces:
+ * <ul>
+ * <li>{@link org.apache.tiles.request.Request} is the main abstraction, 
+ * encapsulating the parameters of the template (as attributes and scopes)
+ * and the target document (as java.io.OutputStream). 
+ * {@link org.apache.tiles.request.DispatchRequest} holds some features common
+ * to servlets and portlets that are unlikely to be found outside of a JavaEE
+ * web environment.
+ * <li>{@link org.apache.tiles.ApplicationContext} can be used to access
+ * application-wide configuration and resources (typically the files containing
+ * the templates).
+ * <li>{@link org.apache.tiles.request.render.Renderer} is the interface supported
+ * by the engine in charge of rendering the template.
+ * <ul>
  */
 package org.apache.tiles.request;

Modified: tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/reflect/package-info.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/reflect/package-info.java?rev=1294457&r1=1294456&r2=1294457&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/reflect/package-info.java (original)
+++ tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/reflect/package-info.java Tue Feb 28 04:45:29 2012
@@ -19,6 +19,6 @@
  * under the License.
  */
 /**
- * Classes to manage reflection in a centralized way for Tiles.
+ * Utilities to work with dynamic class loading and instantiation.
  */
 package org.apache.tiles.request.reflect;

Modified: tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/render/package-info.java
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/render/package-info.java?rev=1294457&r1=1294456&r2=1294457&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/render/package-info.java (original)
+++ tiles/framework/trunk/tiles-request/tiles-request-api/src/main/java/org/apache/tiles/request/render/package-info.java Tue Feb 28 04:45:29 2012
@@ -19,6 +19,17 @@
  * under the License.
  */
 /**
- * Classes to allow rendering of a path in a uniform way.
+ * Classes to allow rendering of a template (described by its path) 
+ * in a uniform way.
+ * 
+ * Besides the top level interface {@link org.apache.tiles.request.render.Renderer},
+ * the package contains:
+ * <ul>
+ * <li>trivial examples: {@link org.apache.tiles.request.render.StringRenderer} 
+ * and {@link org.apache.tiles.request.render.DispatchRenderer}.
+ * <li>usual design patterns: {@link org.apache.tiles.request.render.ChainedDelegateRenderer},
+ * {@link org.apache.tiles.request.render.PublisherRenderer}, and 
+ * {@link org.apache.tiles.request.render.RendererFactory}.
+ * </ul>
  */
 package org.apache.tiles.request.render;