svn commit: r518975 - /cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-api/src/main/java/org/apache/cocoon/environment/ObjectModelHelper.java

[vg...@apache.org]

Author: vgritsenko
Date: Fri Mar 16 06:52:44 2007
New Revision: 518975

URL: http://svn.apache.org/viewvc?view=rev&rev=518975
Log:
write some javadoc for a change

Modified:
    cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-api/src/main/java/org/apache/cocoon/environment/ObjectModelHelper.java

Modified: cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-api/src/main/java/org/apache/cocoon/environment/ObjectModelHelper.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-api/src/main/java/org/apache/cocoon/environment/ObjectModelHelper.java?view=diff&rev=518975&r1=518974&r2=518975
==============================================================================
--- cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-api/src/main/java/org/apache/cocoon/environment/ObjectModelHelper.java (original)
+++ cocoon/trunk/core/cocoon-pipeline/cocoon-pipeline-api/src/main/java/org/apache/cocoon/environment/ObjectModelHelper.java Fri Mar 16 06:52:44 2007
@@ -5,9 +5,9 @@
  * The ASF licenses this file to You under the Apache License, Version 2.0
  * (the "License"); you may not use this file except in compliance with
  * the License.  You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -20,10 +20,12 @@
 
 /**
  * A set of constants and methods to access the content of the object model.
+ *
  * <p>
  * The object model is a <code>Map</code> used to pass information about the
  * calling environment to the sitemap and its components (matchers, actions,
  * transformers, etc).
+ *
  * <p>
  * This class provides accessors only for the objects in the object model that are
  * common to every environment and which can thus be used safely. Some environments
@@ -46,8 +48,8 @@
 
     /** Key for the expiration value (Long) in the object model. */
     public final static String EXPIRES_OBJECT  = "expires";
-    
-    /** Key for the throwable object, only available within a &lt;map:handle-errors>. */
+
+    /** Key for the throwable object, only available within a &lt;map:handle-errors&gt;. */
     public final static String THROWABLE_OBJECT = "throwable";
 
     /**
@@ -61,23 +63,68 @@
         // Forbid instantiation
     }
 
-    public static final Request getRequest(Map objectModel) {
-        return (Request)objectModel.get(REQUEST_OBJECT);
+    /**
+     * Return {@link Request} object stored in the provided
+     * <code>objectModel</code> map.
+     *
+     * @param objectModel current objectModel map
+     * @return request retrieved from the objectModel map
+     */
+    public static Request getRequest(Map objectModel) {
+        return (Request) objectModel.get(REQUEST_OBJECT);
     }
 
-    public static final Response getResponse(Map objectModel) {
-        return (Response)objectModel.get(RESPONSE_OBJECT);
+    /**
+     * Return {@link Response} object stored in the provided
+     * <code>objectModel</code> map.
+     *
+     * @param objectModel current objectModel map
+     * @return response retrieved from the objectModel map
+     */
+    public static Response getResponse(Map objectModel) {
+        return (Response) objectModel.get(RESPONSE_OBJECT);
     }
 
-    public static final Context getContext(Map objectModel) {
-        return (Context)objectModel.get(CONTEXT_OBJECT);
+    /**
+     * Return {@link Context} object stored in the provided
+     * <code>objectModel</code> map.
+     *
+     * @param objectModel current objectModel map
+     * @return context retrieved from the objectModel map
+     */
+    public static Context getContext(Map objectModel) {
+        return (Context) objectModel.get(CONTEXT_OBJECT);
     }
 
-    public static final Long getExpires(Map objectModel) {
-        return (Long)objectModel.get(EXPIRES_OBJECT);
+    /**
+     * Return <code>expires</code> object stored in the provided
+     * <code>objectModel</code> map.
+     *
+     * <p>
+     * <code>expires</code> is an expiration timestamp. This object
+     * is present in the <code>objectModel</code> only in the context
+     * of a pipeline with configured expires parameter.
+     *
+     * @param objectModel current objectModel map
+     * @return expiration timestamp retrieved from the objectModel map
+     */
+    public static Long getExpires(Map objectModel) {
+        return (Long) objectModel.get(EXPIRES_OBJECT);
     }
-    
-    public static final Throwable getThrowable(Map objectModel) {
-        return (Throwable)objectModel.get(THROWABLE_OBJECT);
+
+    /**
+     * Return {@link Throwable} object stored in the provided
+     * <code>objectModel</code> map.
+     *
+     * <p>
+     * <code>Throwable</code> object is present in the objectModel
+     * only within a <code>&lt;map:handle-errors&gt;</code> section
+     * of the sitemap. When outside of this section, null is returned.
+     *
+     * @param objectModel current objectModel map
+     * @return throwable retrieved from the objectModel map
+     */
+    public static Throwable getThrowable(Map objectModel) {
+        return (Throwable) objectModel.get(THROWABLE_OBJECT);
     }
 }