You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by jo...@apache.org on 2003/07/03 01:52:10 UTC
cvs commit: cocoon-2.1/src/java/org/apache/cocoon/generation DirectoryGenerator.java
joerg 2003/07/02 16:52:10
Modified: src/java/org/apache/cocoon/generation
DirectoryGenerator.java
Log:
javadoc formatting,
super.recycle() at the end of recycle()
Revision Changes Path
1.7 +15 -23 cocoon-2.1/src/java/org/apache/cocoon/generation/DirectoryGenerator.java
Index: DirectoryGenerator.java
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/java/org/apache/cocoon/generation/DirectoryGenerator.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- DirectoryGenerator.java 27 Jun 2003 23:00:57 -0000 1.6
+++ DirectoryGenerator.java 2 Jul 2003 23:52:10 -0000 1.7
@@ -269,8 +269,6 @@
/* (non-Javadoc)
* @see org.apache.cocoon.caching.CacheableProcessingComponent#getKey()
- * FIXME: SimpleDateFormat and RE don't have a toString() implemented, so
- * the key generation is buggy!!
*/
public Serializable getKey() {
StringBuffer buffer = new StringBuffer();
@@ -286,6 +284,7 @@
* is initially empty since the files that define it are not known before
* generation has occured. So the returned object is kept by the generator
* and filled with each of the files that are traversed.
+ *
* @see DirectoryGenerator.DirValidity
*/
public SourceValidity getValidity() {
@@ -297,11 +296,9 @@
/**
* Generate XML data.
- *
- * @throws SAXException
- * if an error occurs while outputting the document
- * @throws ProcessingException
- * if the requsted URI isn't a directory on the local filesystem
+ *
+ * @throws SAXException if an error occurs while outputting the document
+ * @throws ProcessingException if the requsted URI isn't a directory on the local filesystem
*/
public void generate() throws SAXException, ProcessingException {
String directory = super.source;
@@ -335,6 +332,7 @@
/**
* Creates a stack containing the ancestors of File up to specified directory.
+ *
* @param path the File whose ancestors shall be retrieved
* @return a Stack containing the ancestors.
*/
@@ -358,6 +356,7 @@
/**
* Adds recursively the path from the directory matched by the root pattern
* down to the requested directory.
+ *
* @param path the requested directory.
* @param ancestors the stack of the ancestors.
* @throws SAXException
@@ -377,10 +376,9 @@
* Adds a single node to the generated document. If the path is a
* directory, and depth is greater than zero, then recursive calls
* are made to add nodes for the directory's children.
- *
+ *
* @param path the file/directory to process
* @param depth how deep to scan the directory
- *
* @throws SAXException if an error occurs while constructing nodes
*/
protected void addPath(File path, int depth) throws SAXException {
@@ -459,10 +457,9 @@
/**
* Begins a named node and calls setNodeAttributes to set its attributes.
- *
+ *
* @param nodeName the name of the new node
* @param path the file/directory to use when setting attributes
- *
* @throws SAXException if an error occurs while creating the node
*/
protected void startNode(String nodeName, File path) throws SAXException {
@@ -477,9 +474,8 @@
* Sets the attributes for a given path. The default method sets attributes
* for the name of thefile/directory and for the last modification time
* of the path.
- *
+ *
* @param path the file/directory to use when setting attributes
- *
* @throws SAXException if an error occurs while setting the attributes
*/
protected void setNodeAttributes(File path) throws SAXException {
@@ -504,9 +500,8 @@
/**
* Ends the named node.
- *
+ *
* @param nodeName the name of the new node
- *
* @throws SAXException if an error occurs while closing the node
*/
protected void endNode(String nodeName) throws SAXException {
@@ -515,9 +510,8 @@
/**
* Determines if a given File is the defined root.
- *
+ *
* @param path the File to check
- *
* @return true if the File is the root or the root pattern is not set,
* false otherwise.
*/
@@ -527,9 +521,8 @@
/**
* Determines if a given File shall be visible.
- *
+ *
* @param path the File to check
- *
* @return true if the File shall be visible or the include Pattern is <code>null</code>,
* false otherwise.
*/
@@ -539,9 +532,8 @@
/**
* Determines if a given File shall be excluded from viewing.
- *
+ *
* @param path the File to check
- *
* @return false if the given File shall not be excluded or the exclude Pattern is <code>null</code>,
* true otherwise.
*/
@@ -553,7 +545,6 @@
* Recycle resources
*/
public void recycle() {
- super.recycle();
this.cacheKeyParList = null;
this.attributes = null;
this.dateFormatter = null;
@@ -561,6 +552,7 @@
this.includeRE = null;
this.excludeRE = null;
this.validity = null;
+ super.recycle();
}
/** Specific validity class, that holds all files that have been generated */