Author: vgritsenko
Date: Fri Mar 11 08:44:23 2005
New Revision: 157110
URL: http://svn.apache.org/viewcvs?view=rev&rev=157110
Log:
javadoc changes mostly
Modified:
cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/treeprocessor/InvokeContext.java
Modified:
cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/treeprocessor/InvokeContext.java
URL:
http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/treeprocessor/InvokeContext.java?view=diff&r1=157109&r2=157110
==============================================================================
---
cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/treeprocessor/InvokeContext.java
(original)
+++
cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/treeprocessor/InvokeContext.java
Fri Mar 11 08:44:23 2005
@@ -1,12 +1,12 @@
/*
- * Copyright 1999-2004 The Apache Software Foundation.
- *
+ * Copyright 1999-2005 The Apache Software Foundation.
+ *
* Licensed 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.
@@ -34,12 +34,13 @@
/**
* The invocation context of <code>ProcessingNode</code>s.
- * <p>
- * This class serves two purposes :
- * <ul><li>Avoid explicit enumeration of all needed parameters in
- * [EMAIL PROTECTED]
ProcessingNode#invoke(org.apache.cocoon.environment.Environment,
InvokeContext)},
- * thus allowing easier addition of new parameters,
- * <li>Hold pipelines, and provide "just in time" lookup for them.
+ *
+ * <p>This class serves two purposes:
+ * <ul>
+ * <li>Avoid explicit enumeration of all needed parameters in
+ * [EMAIL PROTECTED]
ProcessingNode#invoke(org.apache.cocoon.environment.Environment,
InvokeContext)},
+ * thus allowing easier addition of new parameters,</li>
+ * <li>Hold pipelines, and provide "just in time" lookup for them.</li>
* </ul>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Sylvain Wallez</a>
@@ -47,15 +48,14 @@
* @author <a href="mailto:[EMAIL PROTECTED]">Torsten Curdt</a>
* @version CVS $Id$
*/
-
-public class InvokeContext
-extends AbstractLogEnabled
-implements Recomposable, Disposable {
+public class InvokeContext extends AbstractLogEnabled
+ implements Recomposable, Disposable {
private List mapStack = new ArrayList();
private HashMap nameToMap = new HashMap();
private HashMap mapToName = new HashMap();
+ /** True if building pipeline only, not processing it. */
private boolean isBuildingPipelineOnly;
/** The current component manager, as set by the last call to compose() or
recompose() */
@@ -69,7 +69,7 @@
/** The parameters for the processing pipeline */
protected Map processingPipelineParameters;
-
+
/** The object model used to resolve processingPipelineParameters */
protected Map processingPipelineObjectModel;
@@ -78,7 +78,7 @@
/** The redirector */
protected Redirector redirector;
-
+
/** The Selector for the processing pipeline */
protected ComponentSelector pipelineSelector;
@@ -91,7 +91,7 @@
}
/**
- * Determines if the Pipeline been set for this context
+ * Determines if the Pipeline been set for this context
*/
public boolean pipelineIsSet() {
return (this.processingPipeline != null);
@@ -115,9 +115,7 @@
* Recomposable interface
*/
public void recompose(ComponentManager manager) throws ComponentException {
-
this.currentManager = manager;
-
if (this.processingPipeline != null) {
this.processingPipeline.recompose(manager);
}
@@ -242,7 +240,6 @@
}
-
/**
* Pop the topmost element of the current Map stack.
*/
@@ -252,28 +249,27 @@
mapToName.remove(map);
nameToMap.remove(name);
}
-
+
/**
* Set the redirector to be used by nodes that need it.
- *
+ *
* @param redirector the redirector
*/
public void setRedirector(Redirector redirector) {
this.redirector = redirector;
}
-
+
/**
* Get the redirector to be used by nodes that need it.
- *
+ *
* @return the redirector
*/
public Redirector getRedirector() {
return this.redirector;
}
-
+
/**
* Prepare this context for reuse
- *
*/
public final void reset() {
this.mapStack.clear();
@@ -286,18 +282,15 @@
* Release the pipelines, if any, if they were looked up by this context.
*/
public void dispose() {
- // Release pipelines, if any
if (!this.isBuildingPipelineOnly && this.pipelinesManager != null) {
-
- if ( this.pipelineSelector != null) {
+ if (this.pipelineSelector != null) {
this.pipelineSelector.release(this.processingPipeline);
this.processingPipeline = null;
- this.pipelinesManager.release( this.pipelineSelector );
+ this.pipelinesManager.release(this.pipelineSelector);
this.pipelineSelector = null;
}
this.pipelinesManager = null;
this.processingPipelineParameters = null;
}
-
}
}
