lenya-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From e...@apache.org
Subject cvs commit: cocoon-lenya/src/java/org/apache/lenya/cms/publication SiteTree.java
Date Wed, 28 May 2003 12:56:24 GMT
egli        2003/05/28 05:56:24

  Modified:    src/java/org/apache/lenya/cms/publication SiteTree.java
  Log:
  Added JavaDoc.
  
  Revision  Changes    Path
  1.6       +42 -6     cocoon-lenya/src/java/org/apache/lenya/cms/publication/SiteTree.java
  
  Index: SiteTree.java
  ===================================================================
  RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/cms/publication/SiteTree.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- SiteTree.java	27 May 2003 15:31:29 -0000	1.5
  +++ SiteTree.java	28 May 2003 12:56:24 -0000	1.6
  @@ -45,17 +45,53 @@
   
   public interface SiteTree {
   
  -    void addNode(String parentid, String id, Label[] labels)
  +    /**
  +     * Add a node.
  +	 * @param parentid e.g. "/tutorial"
  +	 * @param id e.g. "concepts"
  +	 * @param labels
  +	 * @throws SiteTreeException
  +	 */
  +	void addNode(String parentid, String id, Label[] labels)
   	throws SiteTreeException;
       
  -    void addNode(String parentid, String id, Label[] labels,
  +    /**
  +     * Add a node.
  +	 * @param parentid
  +	 * @param id
  +	 * @param labels
  +	 * @param href
  +	 * @param suffix
  +	 * @param link
  +	 * @throws SiteTreeException
  +	 */
  +	void addNode(String parentid, String id, Label[] labels,
   		 String href, String suffix, boolean link)
   	throws SiteTreeException;
       
  -    void addNode(SiteTreeNode node)
  +    /**
  +     * Add a node. This method is typically used when publishing,
  +     * i.e. when copying a node from the authoring tree to the live
  +     * tree. The existing node already has a parent node (in the
  +     * authoring tree). The node that is added will be a copy of
  +     * the original node and will be inserted at the same parentid
  +     * as the original node.
  +	 * @param node
  +	 * @throws SiteTreeException
  +	 */
  +	void addNode(SiteTreeNode node)
   	throws SiteTreeException;
       
  -    void deleteNode(String id);
  +    /**
  +     * Delete the node with the given document-id
  +	 * @param id
  +	 */
  +	void deleteNode(String id);
       
  -    SiteTreeNode getNode(String documentId);
  +    /**
  +     * Return the Node for a given document-id
  +	 * @param documentId
  +	 * @return
  +	 */
  +	SiteTreeNode getNode(String documentId);
   }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: lenya-cvs-unsubscribe@cocoon.apache.org
For additional commands, e-mail: lenya-cvs-help@cocoon.apache.org


Mime
View raw message