[jboss-cvs] JBossCache/src/org/jboss/cache/optimistic ...

[Manik Surtani]

  User: msurtani
  Date: 07/01/19 09:47:40

  Modified:    src/org/jboss/cache/optimistic  WorkspaceNode.java
  Log:
  Improved Javadocs
  
  Revision  Changes    Path
  1.23      +13 -20    JBossCache/src/org/jboss/cache/optimistic/WorkspaceNode.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: WorkspaceNode.java
  ===================================================================
  RCS file: /cvsroot/jboss/JBossCache/src/org/jboss/cache/optimistic/WorkspaceNode.java,v
  retrieving revision 1.22
  retrieving revision 1.23
  diff -u -b -r1.22 -r1.23
  --- WorkspaceNode.java	10 Jan 2007 17:28:51 -0000	1.22
  +++ WorkspaceNode.java	19 Jan 2007 14:47:40 -0000	1.23
  @@ -12,14 +12,16 @@
   import org.jboss.cache.NodeSPI;
   
   import java.util.Map;
  -import java.util.Set;
   
   /**
    * Represents a type of {@link org.jboss.cache.Node} that is to be copied into a {@link TransactionWorkspace} for optimistically locked
    * nodes.  Adds versioning and dirty flags over conventional Nodes.
  + * <p/>
  + * Typically used when the cache mode configured is {@link org.jboss.cache.config.Configuration.NodeLockingScheme#OPTIMISTIC}
    *
    * @author Manik Surtani (<a href="mailto:manik at jboss.org">manik at jboss.org</a>)
    * @author Steve Woodcock (<a href="mailto:stevew at jofti.com">stevew at jofti.com</a>)
  + * @since 1.3.0
    */
   public interface WorkspaceNode extends Node
   {
  @@ -28,51 +30,42 @@
       *
       * @return a merged map of child names and Nodes
       */
  -   public Map<Object, NodeSPI> getMergedChildren();
  +   Map<Object, NodeSPI> getMergedChildren();
   
      /**
       * Retrieves the data version of the in-memory node.
       *
       * @return A data version
       */
  -   public DataVersion getVersion();
  +   DataVersion getVersion();
   
      /**
       * Sets the data version of this workspace node.
       *
       * @param version a {@link org.jboss.cache.optimistic.DataVersion} implementation.
       */
  -   public void setVersion(DataVersion version);
  -
  -   /**
  -    * Retrieves all data keys
  -    *
  -    * @return an immutable set.
  -    */
  -   public Set<Object> getKeys();
  +   void setVersion(DataVersion version);
   
      /**
       * Returns true if this node needs to be merged when the transaction commits.
       *
       * @return true if needs merging, false otherwise.
       */
  -   public boolean isDirty();
  +   boolean isDirty();
   
      /**
       * Attempts to merge data changed during the current transaction with the data in the underlying tree.
       *
       * @return a merged map of key/value pairs.
       */
  -   public Map<Object, Object> getMergedData();
  +   Map<Object, Object> getMergedData();
   
      /**
       * Retrieves a reference to the underlying {@link NodeSPI} instance.
       *
       * @return a node
       */
  -   public NodeSPI getNode();
  -
  -   public Set<Object> getChildrenNames();
  +   NodeSPI getNode();
   
      /**
       * Retrieves a TransactionWorkspace instance associated with the current transaction, which the current WorkspaceNode instance
  @@ -80,17 +73,17 @@
       *
       * @return a TransactionWorkspace.
       */
  -   public TransactionWorkspace getTransactionWorkspace();
  +   TransactionWorkspace getTransactionWorkspace();
   
      /**
       * @return true if the instance was created in the current transaction; i.e., it did not exist in the underlying data tree.
       */
  -   public boolean isCreated();
  +   boolean isCreated();
   
      /**
       * Marks the instance as having been created in the current transaction.
       */
  -   public void markAsCreated();
  +   void markAsCreated();
   
      /**
       * Creates a child node.
  @@ -101,7 +94,7 @@
       * @param version    DataVersion to apply to the child.  If null, {@link DefaultDataVersion#ZERO} will be used.
       * @return a NodeSPI pointing to the newly created child.
       */
  -   public NodeSPI createChild(Object child_name, NodeSPI parent, CacheSPI cache, DataVersion version);
  +   NodeSPI createChild(Object child_name, NodeSPI parent, CacheSPI cache, DataVersion version);
   
      /**
       * Tests whether versioning for the WorkspaceNode instance in the current transaction is implicit (i.e., using {@link org.jboss.cache.optimistic.DefaultDataVersion}