cziegeler 2004/01/05 05:28:01
Modified: src/java/org/apache/cocoon/environment
EnvironmentContext.java EnvironmentHelper.java
EnvironmentStack.java EnvironmentInfo.java
Log:
Adding some comments
Revision Changes Path
1.3 +5 -1
cocoon-2.2/src/java/org/apache/cocoon/environment/EnvironmentContext.java
Index: EnvironmentContext.java
===================================================================
RCS file:
/home/cvs/cocoon-2.2/src/java/org/apache/cocoon/environment/EnvironmentContext.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- EnvironmentContext.java 5 Jan 2004 12:41:48 -0000 1.2
+++ EnvironmentContext.java 5 Jan 2004 13:28:01 -0000 1.3
@@ -59,6 +59,10 @@
/**
* Experimental code for cleaning up the environment handling
+ * This is an internal class, and it might change in an incompatible way
over time.
+ * For developing your own components/applications based on Cocoon, you
shouldn't
+ * really need it.
+ *
* The environment context can store any additional objects for an
environment.
* This is an alternative to using the attributes of an environment and
* can be used to store internal objects/information wihtout exposing
1.17 +9 -6
cocoon-2.2/src/java/org/apache/cocoon/environment/EnvironmentHelper.java
Index: EnvironmentHelper.java
===================================================================
RCS file:
/home/cvs/cocoon-2.2/src/java/org/apache/cocoon/environment/EnvironmentHelper.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- EnvironmentHelper.java 5 Jan 2004 12:51:41 -0000 1.16
+++ EnvironmentHelper.java 5 Jan 2004 13:28:01 -0000 1.17
@@ -68,6 +68,9 @@
/**
* Experimental code for cleaning up the environment handling
+ * This is an internal class, and it might change in an incompatible way
over time.
+ * For developing your own components/applications based on Cocoon, you
shouldn't
+ * really need it.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @version CVS $Id$
@@ -202,9 +205,9 @@
public void changeContext(Environment env)
throws ProcessingException {
if ( this.lastPrefix != null ) {
- String uris = env.getURI();
+ final String uris = env.getURI();
if (!uris.startsWith(this.lastPrefix)) {
- String message = "The current URI (" + uris +
+ final String message = "The current URI (" + uris +
") doesn't start with given prefix (" +
this.lastPrefix + ")";
throw new ProcessingException(message);
}
@@ -224,9 +227,9 @@
throws ProcessingException {
if ( this.prefix != null ) {
// FIXME - This is not correct!
- String uris = env.getURIPrefix() + env.getURI();
+ final String uris = env.getURIPrefix() + env.getURI();
if (!uris.startsWith(this.prefix)) {
- String message = "The current URI (" + uris +
+ final String message = "The current URI (" + uris +
") doesn't start with given prefix (" +
this.prefix + ")";
throw new ProcessingException(message);
}
@@ -242,7 +245,7 @@
*/
public void changeContext(Source newSource, String newPrefix)
throws IOException {
- String newContext = newSource.getURI();
+ final String newContext = newSource.getURI();
if (getLogger().isDebugEnabled()) {
getLogger().debug("Changing Cocoon context");
getLogger().debug(" from context(" + this.context + ") and
prefix(" + this.prefix + ")");
1.4 +4 -1
cocoon-2.2/src/java/org/apache/cocoon/environment/EnvironmentStack.java
Index: EnvironmentStack.java
===================================================================
RCS file:
/home/cvs/cocoon-2.2/src/java/org/apache/cocoon/environment/EnvironmentStack.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- EnvironmentStack.java 29 Oct 2003 18:58:06 -0000 1.3
+++ EnvironmentStack.java 5 Jan 2004 13:28:01 -0000 1.4
@@ -58,6 +58,9 @@
/**
* The stack for the processing environment.
+ * This is an internal class, and it might change in an incompatible way
over time.
+ * For developing your own components/applications based on Cocoon, you
shouldn't
+ * really need it.
* This is a special implementation of a stack for the handling of the
* cocoon protocol and the sitemap source resolving.
*
1.3 +4 -1
cocoon-2.2/src/java/org/apache/cocoon/environment/EnvironmentInfo.java
Index: EnvironmentInfo.java
===================================================================
RCS file:
/home/cvs/cocoon-2.2/src/java/org/apache/cocoon/environment/EnvironmentInfo.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- EnvironmentInfo.java 30 Oct 2003 12:38:26 -0000 1.2
+++ EnvironmentInfo.java 5 Jan 2004 13:28:01 -0000 1.3
@@ -55,6 +55,9 @@
/**
* Experimental code for cleaning up the environment handling
+ * This is an internal class, and it might change in an incompatible way
over time.
+ * For developing your own components/applications based on Cocoon, you
shouldn't
+ * really need it.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Carsten Ziegeler</a>
* @version CVS $Id$
