Return-Path: Delivered-To: apmail-cocoon-cvs-archive@www.apache.org Received: (qmail 52934 invoked from network); 29 Dec 2007 05:37:07 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 29 Dec 2007 05:37:07 -0000 Received: (qmail 77951 invoked by uid 500); 29 Dec 2007 05:36:56 -0000 Delivered-To: apmail-cocoon-cvs-archive@cocoon.apache.org Received: (qmail 77904 invoked by uid 500); 29 Dec 2007 05:36:55 -0000 Mailing-List: contact cvs-help@cocoon.apache.org; run by ezmlm Precedence: bulk Reply-To: dev@cocoon.apache.org list-help: list-unsubscribe: List-Post: List-Id: Delivered-To: mailing list cvs@cocoon.apache.org Received: (qmail 77893 invoked by uid 99); 29 Dec 2007 05:36:55 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 28 Dec 2007 21:36:55 -0800 X-ASF-Spam-Status: No, hits=-100.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 29 Dec 2007 05:36:48 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id E95171A984E; Fri, 28 Dec 2007 21:36:36 -0800 (PST) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r607378 - in /cocoon/trunk/core/cocoon-sitemap: cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/ cocoon-sitemap-components/src/main/java/org/apache/cocoon/... Date: Sat, 29 Dec 2007 05:36:20 -0000 To: cvs@cocoon.apache.org From: vgritsenko@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20071229053636.E95171A984E@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: vgritsenko Date: Fri Dec 28 21:36:16 2007 New Revision: 607378 URL: http://svn.apache.org/viewvc?rev=607378&view=rev Log: fixing javadocs Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ClearCacheAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ClearPersistentStoreAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/FormValidatorAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/HelloAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/HttpCacheAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/HttpHeaderAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/InputModuleAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/LogAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/PropagatorAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/RequestParamAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/RequestParameterExistsAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ResourceExistsAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionInvalidatorAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionIsValidAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionPropagatorAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionStateAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionValidatorAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SetCharacterEncodingAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SetterAction.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/CookieMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/HeaderMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/MountTableMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/ParameterMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpHeaderMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpHostMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpParameterMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpRequestAttributeMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpRequestParameterMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpSessionAttributeMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpURIMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RequestAttributeMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RequestParameterMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/SessionAttributeMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardHeaderMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardHostMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardParameterMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardRequestAttributeMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardRequestParameterMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardSessionAttributeMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardURIMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/modular/CachingRegexpMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/modular/CachingWildcardMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/modular/WildcardMatcher.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/BrowserSelector.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/CookieSelector.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/ExceptionSelector.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/HeaderSelector.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/HostSelector.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/ParameterSelector.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RegexpHeaderSelector.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RegexpRequestParameterSelector.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RequestAttributeSelector.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RequestMethodSelector.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RequestParameterSelector.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/ResourceExistsSelector.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/SessionAttributeSelector.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/SimpleSelector.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/XPathExceptionSelector.java cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-impl/src/main/java/org/apache/cocoon/sitemap/DefaultContentAggregator.java Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ClearCacheAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ClearCacheAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ClearCacheAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ClearCacheAction.java Fri Dec 28 21:36:16 2007 @@ -25,6 +25,9 @@ import java.util.Map; /** + * Simple action which ensures the cache is cleared of all + * cached results + * * @cocoon.sitemap.component.documentation * Simple action which ensures the cache is cleared of all * cached results Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ClearPersistentStoreAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ClearPersistentStoreAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ClearPersistentStoreAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ClearPersistentStoreAction.java Fri Dec 28 21:36:16 2007 @@ -25,6 +25,8 @@ import java.util.Map; /** + * Simple action which ensures the persistent store is cleared. + * * @cocoon.sitemap.component.documentation * Simple action which ensures the persistent store is cleared. * Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/FormValidatorAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/FormValidatorAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/FormValidatorAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/FormValidatorAction.java Fri Dec 28 21:36:16 2007 @@ -28,12 +28,14 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * This is the action used to validate Request parameters. * - * The parameters are described via the external xml + *

The parameters are described via the external xml * file (its format is defined in AbstractValidatorAction). * @see org.apache.cocoon.acting.AbstractValidatorAction + * + * @cocoon.sitemap.component.documentation + * This is the action used to validate Request parameters. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/HelloAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/HelloAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/HelloAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/HelloAction.java Fri Dec 28 21:36:16 2007 @@ -28,6 +28,9 @@ import org.apache.cocoon.environment.SourceResolver; /** + * A simple Action that tracks if a Session object + * has been created or not. + * * @cocoon.sitemap.component.documentation * A simple Action that tracks if a Session object * has been created or not. Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/HttpCacheAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/HttpCacheAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/HttpCacheAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/HttpCacheAction.java Fri Dec 28 21:36:16 2007 @@ -33,7 +33,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * This action adds the Last-Modified, Expires and * Cache-Control HTTP headers to the response. * @@ -80,6 +79,10 @@ * parameters called last-modified, expires and * cache-control (all lowercase). *

+ * + * @cocoon.sitemap.component.documentation + * This action adds the Last-Modified, Expires and + * Cache-Control HTTP headers to the response. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/HttpHeaderAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/HttpHeaderAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/HttpHeaderAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/HttpHeaderAction.java Fri Dec 28 21:36:16 2007 @@ -30,14 +30,15 @@ import java.util.Map; /** + * This action adds HTTP headers to the response. + * * @cocoon.sitemap.component.documentation * This action adds HTTP headers to the response. * * @version $Id$ */ -public class HttpHeaderAction -extends AbstractConfigurableAction -implements ThreadSafe { +public class HttpHeaderAction extends AbstractConfigurableAction + implements ThreadSafe { /** * Stores keys of global configuration. Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/InputModuleAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/InputModuleAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/InputModuleAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/InputModuleAction.java Fri Dec 28 21:36:16 2007 @@ -31,10 +31,9 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * Simple helper action to allow passing sitemap variables to InputModules. * - * Sitemap evaluation of input modules using the curly bracket syntax e.g. + *

Sitemap evaluation of input modules using the curly bracket syntax e.g. * {defaults:skin} suffers from the fact that it is not * possible to use a sitemap variable as part of the invocation like * {defaults:{1})}. This action takes three parameters, the name @@ -66,8 +65,10 @@ * * * + * @cocoon.sitemap.component.documentation + * Simple helper action to allow passing sitemap variables to InputModules. + * * @see org.apache.cocoon.components.modules.input.InputModule - * * @version $Id$ */ public class InputModuleAction extends ConfigurableServiceableAction implements ThreadSafe { Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/LogAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/LogAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/LogAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/LogAction.java Fri Dec 28 21:36:16 2007 @@ -26,11 +26,9 @@ import org.apache.commons.logging.LogFactory; /** - * @cocoon.sitemap.component.documentation * A simple Action that logs a given message for a given log level. * - *

- * Parameters: + *

Parameters: * * 

  * level (optional):   Indicates the log level, defaults to 'info'
@@ -38,17 +36,13 @@
  * message (optional): The message to log, defaults to 'No log message given'
  *
* - *

- * - * Sitemap definition: + *

Sitemap definition: * * 

  * <map:action name="log" src="org.apache.cocoon.acting.LogAction"/>
  *
* - *

- * - * Example use: + *

Example use: * * 

  * <map:match pattern="some-resource">
@@ -66,7 +60,9 @@
  * </map:match>
  *
* - * + * @cocoon.sitemap.component.documentation + * A simple Action that logs a given message for a given log level. + * * @version $Id$ */ public class LogAction extends AbstractAction implements ThreadSafe { Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/PropagatorAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/PropagatorAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/PropagatorAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/PropagatorAction.java Fri Dec 28 21:36:16 2007 @@ -35,7 +35,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * This is the action used to propagate parameters into a store using an * {@link org.apache.cocoon.components.modules.output.OutputModule}. It * simply propagates given expression. Additionaly it will make all propagated values @@ -110,6 +109,12 @@ * String * * + * + * @cocoon.sitemap.component.documentation + * This is the action used to propagate parameters into a store using an + * {@link org.apache.cocoon.components.modules.output.OutputModule}. It + * simply propagates given expression. Additionaly it will make all propagated values + * available via returned Map. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/RequestParamAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/RequestParamAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/RequestParamAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/RequestParamAction.java Fri Dec 28 21:36:16 2007 @@ -29,7 +29,6 @@ import org.apache.cocoon.environment.SourceResolver; /** - * @cocoon.sitemap.component.documentation * This action makes some request details available to the sitemap via parameter * substitution. * @@ -79,6 +78,10 @@ * * * etc, etc. + * + * @cocoon.sitemap.component.documentation + * This action makes some request details available to the sitemap via parameter + * substitution. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/RequestParameterExistsAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/RequestParameterExistsAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/RequestParameterExistsAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/RequestParameterExistsAction.java Fri Dec 28 21:36:16 2007 @@ -30,11 +30,10 @@ import org.apache.cocoon.environment.SourceResolver; /** - * @cocoon.sitemap.component.documentation * This action simply checks to see if a given request parameter * exists. * - * It takes an arbitrary number of default parameters to check + *

It takes an arbitrary number of default parameters to check * named 'parameter-name'. Non-default parameters need to be separated * by spaces and passed as value of a sitemap parameter named * 'parameters'. The action returns a map with all parameters if all @@ -52,6 +51,10 @@ * checked, whether all parameters with a wildcard have the same * matches. E.g. "id_* name_*" enforces, that if "id_1" exists, * "name_1" must also exist and vice versa.

+ * + * @cocoon.sitemap.component.documentation + * This action simply checks to see if a given request parameter + * exists. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ResourceExistsAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ResourceExistsAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ResourceExistsAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/ResourceExistsAction.java Fri Dec 28 21:36:16 2007 @@ -26,7 +26,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * This action simply checks to see if a resource identified by the src * sitemap attribute exists or not. The action returns empty Map if * resource exists, null otherwise. @@ -37,6 +36,11 @@ *

NOTE: {@link org.apache.cocoon.selection.ResourceExistsSelector} * should be preferred to this component, as the semantics of a Selector better * matches the supplied functionality. + * + * @cocoon.sitemap.component.documentation + * This action simply checks to see if a resource identified by the src + * sitemap attribute exists or not. The action returns empty Map if + * resource exists, null otherwise. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionInvalidatorAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionInvalidatorAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionInvalidatorAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionInvalidatorAction.java Fri Dec 28 21:36:16 2007 @@ -28,6 +28,9 @@ import org.apache.cocoon.environment.SourceResolver; /** + * This is the action used to invalidate an HTTP session. The action returns + * empty map if everything is ok, null otherwise. + * * @cocoon.sitemap.component.documentation * This is the action used to invalidate an HTTP session. The action returns * empty map if everything is ok, null otherwise. Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionIsValidAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionIsValidAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionIsValidAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionIsValidAction.java Fri Dec 28 21:36:16 2007 @@ -27,8 +27,10 @@ import org.apache.cocoon.environment.Request; import org.apache.cocoon.environment.SourceResolver; - /** + * This action just checks if a session exists and whether the current + * seesion is still valid. + * * @cocoon.sitemap.component.documentation * This action just checks if a session exists and whether the current * seesion is still valid. Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionPropagatorAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionPropagatorAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionPropagatorAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionPropagatorAction.java Fri Dec 28 21:36:16 2007 @@ -34,7 +34,6 @@ import org.apache.cocoon.environment.SourceResolver; /** - * @cocoon.sitemap.component.documentation * This is the action used to propagate parameters into session. It * simply propagates given expression to the session. If session does not * exist, action fails. Additionaly it will make all propagated values @@ -42,10 +41,16 @@ * * 

  * <map:act type="session-propagator">
- *      <paramater name="example" value="{example}">
- *      <paramater name="example1" value="xxx">
+ *   <paramater name="example" value="{example}">
+ *   <paramater name="example1" value="xxx">
  * </map:act>
  *
+ * + * @cocoon.sitemap.component.documentation + * This is the action used to propagate parameters into session. It + * simply propagates given expression to the session. If session does not + * exist, action fails. Additionaly it will make all propagated values + * available via returned Map. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionStateAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionStateAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionStateAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionStateAction.java Fri Dec 28 21:36:16 2007 @@ -31,7 +31,6 @@ import org.apache.cocoon.environment.SourceResolver; /** - * @cocoon.sitemap.component.documentation * Store the session's current state in a session attribute. * *

To keep track of the state of a user's session, a string is @@ -76,9 +75,11 @@ * * * + * @cocoon.sitemap.component.documentation + * Store the session's current state in a session attribute. + * * @see org.apache.cocoon.matching.WildcardSessionAttributeMatcher * @see org.apache.cocoon.selection.SessionAttributeSelector - * * @version $Id$ */ public class SessionStateAction Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionValidatorAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionValidatorAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionValidatorAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SessionValidatorAction.java Fri Dec 28 21:36:16 2007 @@ -28,13 +28,16 @@ import org.apache.cocoon.environment.ObjectModelHelper; /** - * @cocoon.sitemap.component.documentation * This is the action used to validate Session parameters (attributes). * The parameters are described via the external xml * file. * - * @see org.apache.cocoon.acting.AbstractValidatorAction + * @cocoon.sitemap.component.documentation + * This is the action used to validate Session parameters (attributes). + * The parameters are described via the external xml + * file. * + * @see org.apache.cocoon.acting.AbstractValidatorAction * @version $Id$ */ public class SessionValidatorAction extends AbstractValidatorAction implements ThreadSafe { Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SetCharacterEncodingAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SetCharacterEncodingAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SetCharacterEncodingAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SetCharacterEncodingAction.java Fri Dec 28 21:36:16 2007 @@ -29,18 +29,22 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * Sets the character encoding of parameters. * - * Components use this encoding as default after the action. - *

- * Configuration parameters: + *

Components use this encoding as default after the action. + * + *

Configuration parameters: + * *

*
form-encoding (optional) *
The supposed encoding of the request parameter. *
* These configuration options supported in both declaration and use time. + * *

If no encoding specified, the action does nothing. + * + * @cocoon.sitemap.component.documentation + * Sets the character encoding of parameters. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SetterAction.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SetterAction.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SetterAction.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/acting/SetterAction.java Fri Dec 28 21:36:16 2007 @@ -27,13 +27,16 @@ import org.apache.cocoon.environment.SourceResolver; /** - * @cocoon.sitemap.component.documentation * This action can be used to set information in either the object model, * the request or the session. * - * All parameters set for this action are set in the according location + *

All parameters set for this action are set in the according location * whereas the parameter name is the key and the value of the parameter * will be set as a string value for this key. + * + * @cocoon.sitemap.component.documentation + * This action can be used to set information in either the object model, + * the request or the session. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/CookieMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/CookieMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/CookieMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/CookieMatcher.java Fri Dec 28 21:36:16 2007 @@ -29,6 +29,8 @@ import org.apache.cocoon.util.AbstractLogEnabled; /** + * Matches cookies agains given name. Returns value of the matched cookie. + * * @cocoon.sitemap.component.documentation * Matches cookies agains given name. Returns value of the matched cookie. * Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/HeaderMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/HeaderMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/HeaderMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/HeaderMatcher.java Fri Dec 28 21:36:16 2007 @@ -25,7 +25,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * This class allows for matching based on a request header. * If the specified request header parameter exists, its value is * retrieved for later sitemap substitution. @@ -36,6 +35,11 @@ * <map:redirect-to uri="{1}"/> * </map:match> * + * + * @cocoon.sitemap.component.documentation + * This class allows for matching based on a request header. + * If the specified request header parameter exists, its value is + * retrieved for later sitemap substitution. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/MountTableMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/MountTableMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/MountTableMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/MountTableMatcher.java Fri Dec 28 21:36:16 2007 @@ -41,7 +41,6 @@ import org.apache.cocoon.util.AbstractLogEnabled; /** - * @cocoon.sitemap.component.documentation * A matcher that manages a "mount table", allowing to add subsitemaps to a Cocoon application without * modifying the main sitemap. This is especially useful for prototypes and demos where installing * a separate instance of Cocoon is overkill. @@ -74,6 +73,11 @@ *

* This configuration is used in the main sitemap of Cocoon samples, to allow users to define their own mount * table, but not fail if it does not exist. + * + * @cocoon.sitemap.component.documentation + * A matcher that manages a "mount table", allowing to add subsitemaps to a Cocoon application without + * modifying the main sitemap. This is especially useful for prototypes and demos where installing + * a separate instance of Cocoon is overkill. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/ParameterMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/ParameterMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/ParameterMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/ParameterMatcher.java Fri Dec 28 21:36:16 2007 @@ -23,7 +23,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * This class allows for matching based on a parameter provided from the sitemap. * If the specified sitemap parameter exists, its value is retrieved for later * sitemap substitution. @@ -34,6 +33,11 @@ * <map:redirect-to uri="{1}"/> * </map:match> * + * + * @cocoon.sitemap.component.documentation + * This class allows for matching based on a parameter provided from the sitemap. + * If the specified sitemap parameter exists, its value is retrieved for later + * sitemap substitution. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpHeaderMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpHeaderMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpHeaderMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpHeaderMatcher.java Fri Dec 28 21:36:16 2007 @@ -26,7 +26,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * Matches a request header (e.g. "referer") against a regular expression. * *

Global and local configuration

@@ -35,12 +34,14 @@ * match against * * + * @cocoon.sitemap.component.documentation + * Matches a request header (e.g. "referer") against a regular expression. + * * @version $Id$ */ - public class RegexpHeaderMatcher extends AbstractRegexpMatcher - implements Configurable -{ + implements Configurable { + private String defaultParam; public void configure(Configuration config) throws ConfigurationException { Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpHostMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpHostMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpHostMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpHostMatcher.java Fri Dec 28 21:36:16 2007 @@ -21,13 +21,15 @@ import java.util.Map; /** + * Matches the target host ("Host" request header) against a regular expression. + * * @cocoon.sitemap.component.documentation * Matches the target host ("Host" request header) against a regular expression. * * @version $Id$ */ -public class RegexpHostMatcher extends AbstractRegexpMatcher -{ +public class RegexpHostMatcher extends AbstractRegexpMatcher { + protected String getMatchString(Map objectModel, Parameters parameters) { return ObjectModelHelper.getRequest(objectModel).getHeader("Host"); } Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpParameterMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpParameterMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpParameterMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpParameterMatcher.java Fri Dec 28 21:36:16 2007 @@ -24,7 +24,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * Matches a sitemap parameter against a regular expression. * *

Global and local configuration

@@ -33,11 +32,14 @@ * match against * * + * @cocoon.sitemap.component.documentation + * Matches a sitemap parameter against a regular expression. + * * @version $Id$ */ public class RegexpParameterMatcher extends AbstractRegexpMatcher - implements Configurable -{ + implements Configurable { + private String defaultParam; public void configure(Configuration config) throws ConfigurationException { Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpRequestAttributeMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpRequestAttributeMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpRequestAttributeMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpRequestAttributeMatcher.java Fri Dec 28 21:36:16 2007 @@ -26,7 +26,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * Matches a request attribute against a regular expression. * *

Global and local configuration

@@ -34,11 +33,13 @@ * attribute-nameString identifying the request attribute * * + * @cocoon.sitemap.component.documentation + * Matches a request attribute against a regular expression. + * * @version $Id$ */ public class RegexpRequestAttributeMatcher extends AbstractRegexpMatcher - implements Configurable -{ + implements Configurable { private String defaultParam; public void configure(Configuration config) throws ConfigurationException { Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpRequestParameterMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpRequestParameterMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpRequestParameterMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpRequestParameterMatcher.java Fri Dec 28 21:36:16 2007 @@ -26,7 +26,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * Matches a request parameter against a regular expression. * *

Global and local configuration

@@ -35,11 +34,14 @@ * match against * * + * @cocoon.sitemap.component.documentation + * Matches a request parameter against a regular expression. + * * @version $Id$ */ public class RegexpRequestParameterMatcher extends AbstractRegexpMatcher - implements Configurable -{ + implements Configurable { + private String defaultParam; public void configure(Configuration config) throws ConfigurationException { Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpSessionAttributeMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpSessionAttributeMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpSessionAttributeMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpSessionAttributeMatcher.java Fri Dec 28 21:36:16 2007 @@ -26,7 +26,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * Matches a session attribute against a regular expression. * *

Global and local configuration

@@ -34,11 +33,14 @@ * attribute-nameString identifying the session attribute * * + * @cocoon.sitemap.component.documentation + * Matches a session attribute against a regular expression. + * * @version $Id$ */ public class RegexpSessionAttributeMatcher extends AbstractRegexpMatcher - implements Configurable -{ + implements Configurable { + private String defaultParam; public void configure(Configuration config) throws ConfigurationException { Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpURIMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpURIMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpURIMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RegexpURIMatcher.java Fri Dec 28 21:36:16 2007 @@ -22,13 +22,15 @@ import java.util.Map; /** + * Matches the request URIs against a regular expression pattern. + * * @cocoon.sitemap.component.documentation * Matches the request URIs against a regular expression pattern. * * @version $Id$ */ -public class RegexpURIMatcher extends AbstractRegexpMatcher -{ +public class RegexpURIMatcher extends AbstractRegexpMatcher { + /** * Return the request URI. */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RequestAttributeMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RequestAttributeMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RequestAttributeMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RequestAttributeMatcher.java Fri Dec 28 21:36:16 2007 @@ -24,7 +24,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * This class allows for matching based on a request attribute. * If the specified request attribute exists, its string representation * is retrieved for later sitemap substitution. @@ -35,6 +34,11 @@ * <map:redirect-to src="{1}"/> * </map:match> * + * + * @cocoon.sitemap.component.documentation + * This class allows for matching based on a request attribute. + * If the specified request attribute exists, its string representation + * is retrieved for later sitemap substitution. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RequestParameterMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RequestParameterMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RequestParameterMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/RequestParameterMatcher.java Fri Dec 28 21:36:16 2007 @@ -25,7 +25,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * This class allows for matching based on a request parameter. * If the specified request parameter exists, its value is retrieved for later * sitemap substitution. @@ -36,6 +35,11 @@ * <map:redirect-to uri="{1}"/> * </map:match> * + * + * @cocoon.sitemap.component.documentation + * This class allows for matching based on a request parameter. + * If the specified request parameter exists, its value is retrieved for later + * sitemap substitution. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/SessionAttributeMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/SessionAttributeMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/SessionAttributeMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/SessionAttributeMatcher.java Fri Dec 28 21:36:16 2007 @@ -24,7 +24,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * This class allows for matching based on a session attribute. * If the specified session attribute exists, its string representation * is retrieved for later sitemap substitution. @@ -36,10 +35,15 @@ * </map:match> * * + * @cocoon.sitemap.component.documentation + * This class allows for matching based on a session attribute. + * If the specified session attribute exists, its string representation + * is retrieved for later sitemap substitution. + * * @version $Id$ */ -public class SessionAttributeMatcher implements Matcher, ThreadSafe -{ +public class SessionAttributeMatcher implements Matcher, ThreadSafe { + /** * Match method to see if the request attribute exists. If it does * have a value the string represenation of attribute is added to Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardHeaderMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardHeaderMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardHeaderMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardHeaderMatcher.java Fri Dec 28 21:36:16 2007 @@ -26,7 +26,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * Matches a request header (e.g. "referer") against a wildcard expression. * *

Global and local configuration

@@ -35,11 +34,14 @@ * match against * * + * @cocoon.sitemap.component.documentation + * Matches a request header (e.g. "referer") against a wildcard expression. + * * @version $Id$ */ public class WildcardHeaderMatcher extends AbstractWildcardMatcher - implements Configurable -{ + implements Configurable { + private String defaultParam; public void configure(Configuration config) throws ConfigurationException { Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardHostMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardHostMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardHostMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardHostMatcher.java Fri Dec 28 21:36:16 2007 @@ -21,13 +21,15 @@ import java.util.Map; /** + * Matches the target host ("Host" request header) against a wildcard expression. + * * @cocoon.sitemap.component.documentation * Matches the target host ("Host" request header) against a wildcard expression. * * @version $Id$ */ -public class WildcardHostMatcher extends AbstractWildcardMatcher -{ +public class WildcardHostMatcher extends AbstractWildcardMatcher { + protected String getMatchString(Map objectModel, Parameters parameters) { return ObjectModelHelper.getRequest(objectModel).getHeader("Host"); } Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardParameterMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardParameterMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardParameterMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardParameterMatcher.java Fri Dec 28 21:36:16 2007 @@ -24,7 +24,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * Matches a sitemap parameter against a wildcard expression. * *

Global and local configuration

@@ -32,6 +31,9 @@ * parameter-nameName of the sitemap parameter to * match against * + * + * @cocoon.sitemap.component.documentation + * Matches a sitemap parameter against a wildcard expression. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardRequestAttributeMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardRequestAttributeMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardRequestAttributeMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardRequestAttributeMatcher.java Fri Dec 28 21:36:16 2007 @@ -26,7 +26,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * Matches a request attribute against a wildcard expression. * *

Global and local configuration

@@ -34,11 +33,14 @@ * attribute-nameString identifying the request attribute * * + * @cocoon.sitemap.component.documentation + * Matches a request attribute against a wildcard expression. + * * @version $Id$ */ public class WildcardRequestAttributeMatcher extends AbstractWildcardMatcher - implements Configurable -{ + implements Configurable { + private String defaultParam; public void configure(Configuration config) throws ConfigurationException { Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardRequestParameterMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardRequestParameterMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardRequestParameterMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardRequestParameterMatcher.java Fri Dec 28 21:36:16 2007 @@ -26,7 +26,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * Matches a request parameter against a wildcard expression. * *

Global and local configuration

@@ -35,11 +34,14 @@ * match against * * + * @cocoon.sitemap.component.documentation + * Matches a request parameter against a wildcard expression. + * * @version $Id$ */ public class WildcardRequestParameterMatcher extends AbstractWildcardMatcher - implements Configurable -{ + implements Configurable { + private String defaultParam; public void configure(Configuration config) throws ConfigurationException { Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardSessionAttributeMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardSessionAttributeMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardSessionAttributeMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardSessionAttributeMatcher.java Fri Dec 28 21:36:16 2007 @@ -26,7 +26,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * Matches a session attribute against a wildcard expression. * *

Global and local configuration

@@ -34,11 +33,14 @@ * attribute-nameString identifying the session attribute * * + * @cocoon.sitemap.component.documentation + * Matches a session attribute against a wildcard expression. + * * @version $Id$ */ public class WildcardSessionAttributeMatcher extends AbstractWildcardMatcher - implements Configurable -{ + implements Configurable { + private String defaultParam; public void configure(Configuration config) throws ConfigurationException { Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardURIMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardURIMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardURIMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/WildcardURIMatcher.java Fri Dec 28 21:36:16 2007 @@ -22,13 +22,15 @@ import java.util.Map; /** + * Match the request URI against a wildcard expression. + * * @cocoon.sitemap.component.documentation * Match the request URI against a wildcard expression. * * @version $Id$ */ -public class WildcardURIMatcher extends AbstractWildcardMatcher -{ +public class WildcardURIMatcher extends AbstractWildcardMatcher { + /** * Return the request URI. */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/modular/CachingRegexpMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/modular/CachingRegexpMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/modular/CachingRegexpMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/modular/CachingRegexpMatcher.java Fri Dec 28 21:36:16 2007 @@ -35,7 +35,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * Matches against a regular expression. Needs an input module to * obtain value to match against. * @@ -45,11 +44,15 @@ * parameter-nameName of the parameter to match * against * * + * @cocoon.sitemap.component.documentation + * Matches against a regular expression. Needs an input module to + * obtain value to match against. + * * @version $Id$ */ public class CachingRegexpMatcher extends AbstractRegexpMatcher - implements Configurable, Initializable, Serviceable, Disposable -{ + implements Configurable, Initializable, Serviceable, + Disposable { /** The service manager instance */ protected ServiceManager manager; Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/modular/CachingWildcardMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/modular/CachingWildcardMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/modular/CachingWildcardMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/modular/CachingWildcardMatcher.java Fri Dec 28 21:36:16 2007 @@ -34,7 +34,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * Matches against a wildcard expression. Needs an input module to * obtain value to match against. * @@ -44,11 +43,15 @@ * parameter-nameName of the parameter to match * against * * + * @cocoon.sitemap.component.documentation + * Matches against a wildcard expression. Needs an input module to + * obtain value to match against. + * * @version $Id$ */ public class CachingWildcardMatcher extends AbstractWildcardMatcher - implements Configurable, Initializable, Serviceable, Disposable -{ + implements Configurable, Initializable, Serviceable, + Disposable { /** The service manager instance */ protected ServiceManager manager; Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/modular/WildcardMatcher.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/modular/WildcardMatcher.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/modular/WildcardMatcher.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/matching/modular/WildcardMatcher.java Fri Dec 28 21:36:16 2007 @@ -31,7 +31,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * Matches against a wildcard expression. Needs an input module to * obtain value to match against. * @@ -41,11 +40,14 @@ * parameter-nameName of the parameter to match * against * * + * @cocoon.sitemap.component.documentation + * Matches against a wildcard expression. Needs an input module to + * obtain value to match against. + * * @version $Id$ */ public class WildcardMatcher extends AbstractWildcardMatcher - implements Configurable, Serviceable -{ + implements Configurable, Serviceable { /** The service manager instance */ protected ServiceManager manager; Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/BrowserSelector.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/BrowserSelector.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/BrowserSelector.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/BrowserSelector.java Fri Dec 28 21:36:16 2007 @@ -24,6 +24,8 @@ import java.util.Map; /** + * Tests a specific browser pattern against the requesting user-agent. + * * @cocoon.sitemap.component.documentation * Tests a specific browser pattern against the requesting user-agent. * Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/CookieSelector.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/CookieSelector.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/CookieSelector.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/CookieSelector.java Fri Dec 28 21:36:16 2007 @@ -29,7 +29,6 @@ import org.apache.cocoon.util.AbstractLogEnabled; /** - * @cocoon.sitemap.component.documentation * A Selector that matches a string against a configurable cookie's value. * *

Global and local configuration

@@ -39,6 +38,9 @@ * Name of the cookie whose value to match against * * + * + * @cocoon.sitemap.component.documentation + * A Selector that matches a string against a configurable cookie's value. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/ExceptionSelector.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/ExceptionSelector.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/ExceptionSelector.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/ExceptionSelector.java Fri Dec 28 21:36:16 2007 @@ -27,7 +27,6 @@ import org.apache.commons.lang.exception.ExceptionUtils; /** - * @cocoon.sitemap.component.documentation * In a <map:handle-errors>, selects depending on the exception that caused the error. * The configuration of this selector allows to map exception class names to symbolic names * that are used in the <map:when> alternatives. @@ -50,6 +49,11 @@ * the exception name * Note that both "name" and "unroll" can be specified. In that case, we first try to unroll the exception, * and if none of the causes has a name, then the "name" attribute is considered. + * + * @cocoon.sitemap.component.documentation + * In a <map:handle-errors>, selects depending on the exception that caused the error. + * The configuration of this selector allows to map exception class names to symbolic names + * that are used in the <map:when> alternatives. * * @since 2.1 * @version $Id$ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/HeaderSelector.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/HeaderSelector.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/HeaderSelector.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/HeaderSelector.java Fri Dec 28 21:36:16 2007 @@ -28,7 +28,6 @@ import org.apache.cocoon.util.AbstractLogEnabled; /** - * @cocoon.sitemap.component.documentation * A Selector that matches a string against a configurable * request header, e.g. "referer". * @@ -37,6 +36,10 @@ * header-nameName of the request header to * match against * + * + * @cocoon.sitemap.component.documentation + * A Selector that matches a string against a configurable + * request header, e.g. "referer". * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/HostSelector.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/HostSelector.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/HostSelector.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/HostSelector.java Fri Dec 28 21:36:16 2007 @@ -24,7 +24,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * A Selector that matches a string from within the host parameter * of the HTTP request. * @@ -45,6 +44,10 @@ * </map:otherwise> * </map:select> * + * + * @cocoon.sitemap.component.documentation + * A Selector that matches a string from within the host parameter + * of the HTTP request. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/ParameterSelector.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/ParameterSelector.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/ParameterSelector.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/ParameterSelector.java Fri Dec 28 21:36:16 2007 @@ -22,7 +22,6 @@ import java.util.Map; /** - * @cocoon.sitemap.component.documentation * A Selector that matches a string in the parameters object passed to it. * * 
@@ -44,6 +43,9 @@
  * The purpose of this selector is to allow an action to set parameters
  * and to be able to select between different pipeline configurations
  * depending on those parameters.
+ *
+ * @cocoon.sitemap.component.documentation
+ * A Selector that matches a string in the parameters object passed to it.
  *
  * @version $Id$
  */

Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RegexpHeaderSelector.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RegexpHeaderSelector.java?rev=607378&r1=607377&r2=607378&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RegexpHeaderSelector.java (original)
+++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RegexpHeaderSelector.java Fri Dec 28 21:36:16 2007
@@ -24,7 +24,6 @@
 import org.apache.cocoon.environment.ObjectModelHelper;
 
 /**
- * @cocoon.sitemap.component.documentation
  * The RegexpHeaderSelector class defines a selector matching
  * specific headers to configured regular-expression patterns. 
  *
@@ -51,6 +50,10 @@
  * also be specified as a <map:parameter .../> inside the
  * pipeline itself.

  * 
+ * @cocoon.sitemap.component.documentation
+ * The RegexpHeaderSelector class defines a selector matching
+ * specific headers to configured regular-expression patterns.
+ *
  * @version $Id$
  */
 public class RegexpHeaderSelector extends AbstractRegexpSelector {

Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RegexpRequestParameterSelector.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RegexpRequestParameterSelector.java?rev=607378&r1=607377&r2=607378&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RegexpRequestParameterSelector.java (original)
+++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RegexpRequestParameterSelector.java Fri Dec 28 21:36:16 2007
@@ -24,7 +24,6 @@
 import org.apache.cocoon.environment.ObjectModelHelper;
 
 /**
- * @cocoon.sitemap.component.documentation
  * The RegexpRequestParameterSelector class defines a selector matching
  * specific request parameters to configured regular-expression patterns. 
  *
@@ -51,6 +50,10 @@
  * also be specified as a <map:parameter .../> inside the
  * pipeline itself.

  * 
+ * @cocoon.sitemap.component.documentation
+ * The RegexpRequestParameterSelector class defines a selector matching
+ * specific request parameters to configured regular-expression patterns.
+ *
  * @version $Id$
  */
 public class RegexpRequestParameterSelector extends AbstractRegexpSelector {

Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RequestAttributeSelector.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RequestAttributeSelector.java?rev=607378&r1=607377&r2=607378&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RequestAttributeSelector.java (original)
+++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RequestAttributeSelector.java Fri Dec 28 21:36:16 2007
@@ -28,7 +28,6 @@
 import org.apache.cocoon.util.AbstractLogEnabled;
 
 /**
- * @cocoon.sitemap.component.documentation
  * A Selector that matches a string against a configurable request
  * attribute's string represenation.
  *
@@ -36,6 +35,10 @@
  * 
  * 
  * 
attribute-nameString identifying the request attribute.

+ *
+ * @cocoon.sitemap.component.documentation
+ * A Selector that matches a string against a configurable request
+ * attribute's string represenation.
  *
  * @version $Id$
  */

Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RequestMethodSelector.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RequestMethodSelector.java?rev=607378&r1=607377&r2=607378&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RequestMethodSelector.java (original)
+++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RequestMethodSelector.java Fri Dec 28 21:36:16 2007
@@ -25,6 +25,8 @@
 import org.apache.cocoon.util.AbstractLogEnabled;
 
 /**
+ * A Selector that matches a getMethod() of the HTTP request.
+ *
  * @cocoon.sitemap.component.documentation
  * A Selector that matches a getMethod() of the HTTP request.
  *

Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RequestParameterSelector.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RequestParameterSelector.java?rev=607378&r1=607377&r2=607378&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RequestParameterSelector.java (original)
+++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/RequestParameterSelector.java Fri Dec 28 21:36:16 2007
@@ -25,7 +25,6 @@
 import java.util.Map;
 
 /**
- * @cocoon.sitemap.component.documentation
  * A Selector that matches a string against a configurable request parameter's value.
  *
  * 
Global and local configuration

@@ -33,6 +32,9 @@
  * parameter-nameName of the request
  * parameter whose value to match against
  * 
+ *
+ * @cocoon.sitemap.component.documentation
+ * A Selector that matches a string against a configurable request parameter's value.
  *
  * @version $Id$
  */

Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/ResourceExistsSelector.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/ResourceExistsSelector.java?rev=607378&r1=607377&r2=607378&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/ResourceExistsSelector.java (original)
+++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/ResourceExistsSelector.java Fri Dec 28 21:36:16 2007
@@ -31,7 +31,6 @@
 import org.apache.cocoon.util.AbstractLogEnabled;
 
 /**
- * @cocoon.sitemap.component.documentation
  * Selects the first of a set of Resources (usually files) that exists.
  * 
  * 

@@ -75,6 +74,9 @@
  *    </map:select<
  *    <map:serialize type="fo2pdf" /<
  *
+ * + * @cocoon.sitemap.component.documentation + * Selects the first of a set of Resources (usually files) that exists. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/SessionAttributeSelector.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/SessionAttributeSelector.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/SessionAttributeSelector.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/SessionAttributeSelector.java Fri Dec 28 21:36:16 2007 @@ -28,7 +28,6 @@ import org.apache.cocoon.util.AbstractLogEnabled; /** - * @cocoon.sitemap.component.documentation * A Selector that matches a string against a configurable session * attribute's string representation. * @@ -36,6 +35,10 @@ * * *
attribute-nameString identifying the session attribute.
+ * + * @cocoon.sitemap.component.documentation + * A Selector that matches a string against a configurable session + * attribute's string representation. * * @version $Id$ */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/SimpleSelector.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/SimpleSelector.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/SimpleSelector.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/SimpleSelector.java Fri Dec 28 21:36:16 2007 @@ -21,11 +21,10 @@ import org.apache.avalon.framework.parameters.Parameters; /** - * @cocoon.sitemap.component.documentation - * A very simple selector that operates on string literals, useful especially + * A very simple selector that operates on string literals, useful especially * in conjunction with input modules. * - * Usage example: + *

Usage example: * 

  *    <map:selector name="simple" src="org.apache.cocoon.selection.SimpleSelector"/>
  * 
@@ -46,6 +45,10 @@
  *    </map:select>
  *
* + * @cocoon.sitemap.component.documentation + * A very simple selector that operates on string literals, useful especially + * in conjunction with input modules. + * * @version $Id$ * @since 2.1 */ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/XPathExceptionSelector.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/XPathExceptionSelector.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/XPathExceptionSelector.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-components/src/main/java/org/apache/cocoon/selection/XPathExceptionSelector.java Fri Dec 28 21:36:16 2007 @@ -28,15 +28,14 @@ import org.apache.commons.jxpath.JXPathContext; /** - * @cocoon.sitemap.component.documentation * Additional to the inherited functionality from its superclass ExceptionSelector, * this selector allows to define xpath expressions to evaluate supplemental information * given in the thrown exception. * - * The configuration of this selector allows to map not only exceptions but also + *

The configuration of this selector allows to map not only exceptions but also * xpath expressions to symbolic names that are used in the <map:when> alternatives. - *

- * Example configuration : + * + *

Example configuration : * 

  *   <map:selector type="error" src="....XPathExceptionSelector">
  *     <exception name="denied" class="my.comp.auth.AuthenticationFailure">
@@ -46,9 +45,16 @@
  *     </exception>
  *   </map:selector>
  *
- * This example shows several features : + * This example shows several features: + *
    *
  • the test is the xpath expression that will be evaluated against the exception ,
    • - *
  • an xpath expression can be given a name, which is used in the <map:when> tests,
    • + *
  • an xpath expression can be given a name, which is used in the <map:when> tests
    • + *
      + * + * @cocoon.sitemap.component.documentation + * Additional to the inherited functionality from its superclass ExceptionSelector, + * this selector allows to define xpath expressions to evaluate supplemental information + * given in the thrown exception. * * @since 2.1 * @version $Id$ Modified: cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-impl/src/main/java/org/apache/cocoon/sitemap/DefaultContentAggregator.java URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-impl/src/main/java/org/apache/cocoon/sitemap/DefaultContentAggregator.java?rev=607378&r1=607377&r2=607378&view=diff ============================================================================== --- cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-impl/src/main/java/org/apache/cocoon/sitemap/DefaultContentAggregator.java (original) +++ cocoon/trunk/core/cocoon-sitemap/cocoon-sitemap-impl/src/main/java/org/apache/cocoon/sitemap/DefaultContentAggregator.java Fri Dec 28 21:36:16 2007 @@ -44,6 +44,10 @@ import java.util.Map; /** + * This generator implements the sitemap content aggregation. + * It combines several parts into one big XML document which is streamed + * into the pipeline. + * * @cocoon.sitemap.component.documentation * This generator implements the sitemap content aggregation. * It combines several parts into one big XML document which is streamed