Author: ddewolf
Date: Thu Nov 2 13:06:46 2006
New Revision: 470521
URL: http://svn.apache.org/viewvc?view=rev&rev=470521
Log:
Removing URLViewPreparer; Cleaning up JavaDocs for Preparers
Removed:
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/UrlViewPreparer.java
Modified:
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/BasicPreparerFactory.java
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/PreparerException.java
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/PreparerFactory.java
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/ViewPreparer.java
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/ViewPreparerSupport.java
Modified:
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/BasicPreparerFactory.java
URL:
http://svn.apache.org/viewvc/struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/BasicPreparerFactory.java?view=diff&rev=470521&r1=470520&r2=470521
==============================================================================
---
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/BasicPreparerFactory.java
(original)
+++
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/BasicPreparerFactory.java
Thu Nov 2 13:06:46 2006
@@ -31,6 +31,9 @@
* Default implementation of the [EMAIL PROTECTED] PreparerFactory}.
* This factory provides no contextual configuration. It
* simply instantiates the named preparerInstance and returns it.
+ *
+ * @since Tiles 2.0
+ * @version $Rev$
*/
public class BasicPreparerFactory implements PreparerFactory {
Modified:
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/PreparerException.java
URL:
http://svn.apache.org/viewvc/struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/PreparerException.java?view=diff&rev=470521&r1=470520&r2=470521
==============================================================================
---
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/PreparerException.java
(original)
+++
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/PreparerException.java
Thu Nov 2 13:06:46 2006
@@ -21,6 +21,16 @@
import org.apache.tiles.TilesException;
+/**
+ * <p>
+ * Thrown when an exception occurs while processing
+ * a prepare request.
+ * </p>
+ *
+ * @since Tiles 2.0
+ * @version $Rev$
+ *
+ */
public class PreparerException extends TilesException {
public PreparerException(String message) {
Modified:
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/PreparerFactory.java
URL:
http://svn.apache.org/viewvc/struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/PreparerFactory.java?view=diff&rev=470521&r1=470520&r2=470521
==============================================================================
---
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/PreparerFactory.java
(original)
+++
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/PreparerFactory.java
Thu Nov 2 13:06:46 2006
@@ -22,13 +22,17 @@
import org.apache.tiles.TilesRequestContext;
/**
+ * <p>
* Factory interface used to create/retrieve instances of
* the [EMAIL PROTECTED] ViewPreparer} interface.
* <p/>
+ *
+ * <p>
* This factory provides an extension point into the default
* tiles implementation. Implementors wishing to provide
* per request initialization of the ViewPreparer (for instance)
* may provide a custom prerparer.
+ * </p>
*
* @verion $Id$
* @since 2.0
Modified:
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/ViewPreparer.java
URL:
http://svn.apache.org/viewvc/struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/ViewPreparer.java?view=diff&rev=470521&r1=470520&r2=470521
==============================================================================
---
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/ViewPreparer.java
(original)
+++
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/ViewPreparer.java
Thu Nov 2 13:06:46 2006
@@ -23,9 +23,22 @@
import org.apache.tiles.TilesRequestContext;
/**
- * A preparerInstance is a piece of code called before rendering a jsp page.
- * A preparerInstance can be associated to a tile. See <insert> or
- * <definition> for association syntax.
+ * <p>
+ * Executed prior to rendering a view.
+ * </p>
+ *
+ * <p>
+ * A view preparer is typically used to provide last minute
+ * translations of the data within the Component or Tiles Context.
+ * A preparer is not intended to replace the controller within an
+ * MVC architecture.
+ * </p>
+ *
+ * See
+ * <ul>
+ * <li><insert></li>
+ * <li><definition></li>
+ * <li>
*/
public interface ViewPreparer {
Modified:
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/ViewPreparerSupport.java
URL:
http://svn.apache.org/viewvc/struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/ViewPreparerSupport.java?view=diff&rev=470521&r1=470520&r2=470521
==============================================================================
---
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/ViewPreparerSupport.java
(original)
+++
struts/sandbox/trunk/tiles/tiles-core/src/main/java/org/apache/tiles/preparer/ViewPreparerSupport.java
Thu Nov 2 13:06:46 2006
@@ -26,6 +26,9 @@
* Basic implementation of ViewPreparer. Implementations can extend this class
* to insulate themselves from changes in the <code>ViewPreparer</code>
* interface.
+ *
+ * @since Tiles 2.0
+ * @version $Rev$
*/
public class ViewPreparerSupport implements ViewPreparer {
