[jboss-cvs] jboss-persistence/src/main/javax/jdo Extent.java PersistenceManager.java

[Alexey L. <lou...@us...>]

  User: loubyansky
  Date: 03/06/22 07:38:13

  Modified:    src/main/javax/jdo Extent.java PersistenceManager.java
  Log:
  added javadoc
  
  Revision  Changes    Path
  1.2       +38 -0     jboss-persistence/src/main/javax/jdo/Extent.java
  
  Index: Extent.java
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-persistence/src/main/javax/jdo/Extent.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- Extent.java	3 Jun 2003 10:12:06 -0000	1.1
  +++ Extent.java	22 Jun 2003 14:38:13 -0000	1.2
  @@ -14,15 +14,53 @@
    */
   public interface Extent
   {
  +   /**
  +    * Close an Iterator associated with this Extent instance.
  +    * Iterators closed by this method will return false to hasNext()
  +    * and will throw NoSuchElementException on next(). The Extent instance
  +    * can still be used as a parameter of Query.setExtent, and to get an Iterator.
  +    *
  +    * @param it - an Iterator obtained by the method iterator() on this Extent instance.
  +    */
      void close(Iterator it);
   
  +   /**
  +    * Close all Iterators associated with this Extent instance.
  +    * Iterators closed by this method will return false to hasNext()
  +    * and will throw NoSuchElementException on next(). The Extent instance
  +    * can still be used as a parameter of Query.setExtent, and to get an Iterator.
  +    */
      void closeAll();
   
  +   /**
  +    * An Extent contains all instances of a particular class in the data store;
  +    * this method returns the Class of the instances.
  +    *
  +    * @return the Class of instances of this Extent.
  +    */
      Class getCandidateClass();
   
  +   /**
  +    * An Extent is managed by a PersistenceManager;
  +    * this method gives access to the owning PersistenceManager.
  +    *
  +    * @return the owning PersistenceManager
  +    */
      PersistenceManager getPersistenceManager();
   
  +   /**
  +    * Returns whether this Extent was defined to contain subclasses.
  +    *
  +    * @return true if this Extent was defined to contain instances that are of a subclass type.
  +    */
      boolean hasSubclasses();
   
  +   /**
  +    * Returns an iterator over all the instances in the Extent.
  +    * The behavior of the returned iterator might depend on the setting of the ignoreCache flag
  +    * in the owning PersistenceManager.
  +    *
  +    * @return an iterator over all instances in the Extent
  +    */
      Iterator iterator();
   }
  
  
  
  1.2       +4 -4      jboss-persistence/src/main/javax/jdo/PersistenceManager.java
  
  Index: PersistenceManager.java
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-persistence/src/main/javax/jdo/PersistenceManager.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- PersistenceManager.java	3 Jun 2003 10:12:07 -0000	1.1
  +++ PersistenceManager.java	22 Jun 2003 14:38:13 -0000	1.2
  @@ -54,13 +54,13 @@
   
      Query newQuery(Extent extent, String s);
   
  -   Extent getExtent(Class aClass, boolean b);
  +   Extent getExtent(Class candidateClass, boolean subclasses);
   
  -   Object getObjectById(Object o, boolean b);
  +   Object getObjectById(Object objectId, boolean validate);
   
  -   Object getObjectId(Object o);
  +   Object getObjectId(Object pc);
   
  -   Object getTransactionalObjectId(Object o);
  +   Object getTransactionalObjectId(Object pc);
   
      Object newObjectIdInstance(Class aClass, String s);