You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by eg...@apache.org on 2003/09/12 19:35:02 UTC
cvs commit: cocoon-lenya/src/java/org/apache/lenya/cms/publication SiteTreeNode.java
egli 2003/09/12 10:35:02
Modified: src/java/org/apache/lenya/cms/publication SiteTreeNode.java
Log:
Added some more documentation to a docstring.
Revision Changes Path
1.10 +85 -84 cocoon-lenya/src/java/org/apache/lenya/cms/publication/SiteTreeNode.java
Index: SiteTreeNode.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/cms/publication/SiteTreeNode.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- SiteTreeNode.java 25 Aug 2003 17:42:08 -0000 1.9
+++ SiteTreeNode.java 12 Sep 2003 17:35:02 -0000 1.10
@@ -64,7 +64,7 @@
* @version $Revision$
*/
public interface SiteTreeNode {
-
+
/**
* Get the parent-id of this node.
*
@@ -72,101 +72,102 @@
*/
String getParentId();
- /**
- * Get the absolute parent-id of this node.
- *
- * @return the absolute parent-id.
- */
+ /**
+ * Get the absolute parent-id of this node.
+ *
+ * @return the absolute parent-id.
+ */
String getAbsoluteParentId();
- /**
- * Get the id of this node.
- *
- * @return the node id.
- */
+ /**
+ * Get the id of this node.
+ *
+ * @return the node id.
+ */
String getId();
- /**
- * Get all labels for this node (independent of their language attribute).
- *
- * @return an <code>Array</code> of labels.
- */
+ /**
+ * Get all labels for this node (independent of their language attribute).
+ *
+ * @return an <code>Array</code> of labels.
+ */
Label[] getLabels();
- /**
- * Get the label for a specific language.
- *
- * @param xmlLanguage the language for which the label is requested.
- *
- * @return a <code>Label</code>
- */
+ /**
+ * Get the label for a specific language.
+ *
+ * @param xmlLanguage the language for which the label is requested.
+ *
+ * @return a <code>Label</code> if there is one for the given language,
+ * null otherwise.
+ */
Label getLabel(String xmlLanguage);
-
- /**
- * Add a label to this node iff the node does not have this label already.
- *
- * @param label the label to be added.
- */
- void addLabel(Label label);
-
- /**
- * Remove a label from this node.
- *
- * @param label the label to be removed.
- */
- void removeLabel(Label label);
-
- /**
- * Get the href of this node.
- *
- * @return the href.
- */
+
+ /**
+ * Add a label to this node iff the node does not have this label already.
+ *
+ * @param label the label to be added.
+ */
+ void addLabel(Label label);
+
+ /**
+ * Remove a label from this node.
+ *
+ * @param label the label to be removed.
+ */
+ void removeLabel(Label label);
+
+ /**
+ * Get the href of this node.
+ *
+ * @return the href.
+ */
String getHref();
- /**
- * Get the suffix of this node.
- *
- * @return the suffix.
- */
+ /**
+ * Get the suffix of this node.
+ *
+ * @return the suffix.
+ */
String getSuffix();
- /**
- * Check whether this node has a link.
- *
- * @return true if this node has a link.
- */
+ /**
+ * Check whether this node has a link.
+ *
+ * @return true if this node has a link.
+ */
boolean hasLink();
- /**
- * Get the sitetreenodes, which are children of this node
- *
- * @return the children.
- */
- SiteTreeNode[] getChildren();
-
- /**
- * Remove the children of the node
- *
- * @return the removed node
- */
- SiteTreeNode[] removeChildren();
-
- /**
- * Call the visit method of the visitor, that mean
- * the operation that shall be perfoemed on this node
- * (Visitor pattern)
- * @param visitor The visitor.
+ /**
+ * Get the sitetreenodes, which are children of this node
+ *
+ * @return the children.
+ */
+ SiteTreeNode[] getChildren();
+
+ /**
+ * Remove the children of the node
+ *
+ * @return the removed node
+ */
+ SiteTreeNode[] removeChildren();
+
+ /**
+ * Call the visit method of the visitor, that mean
+ * the operation that shall be perfoemed on this node
+ * (Visitor pattern)
+ * @param visitor The visitor.
*
* @throws DocumentException if an error occurs
- */
- void accept (SiteTreeNodeVisitor visitor) throws DocumentException;
-
- /**
- * Traverse the node ant its children and call the
- * accept method.
- * @param visitor The visitor.
+ */
+ void accept(SiteTreeNodeVisitor visitor) throws DocumentException;
+
+ /**
+ * Traverse the node ant its children and call the
+ * accept method.
+ * @param visitor The visitor.
*
* @throws DocumentException if an error occurs
- */
- void acceptSubtree (SiteTreeNodeVisitor visitor) throws DocumentException;
+ */
+ void acceptSubtree(SiteTreeNodeVisitor visitor) throws DocumentException;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: lenya-cvs-unsubscribe@cocoon.apache.org
For additional commands, e-mail: lenya-cvs-help@cocoon.apache.org