db-jdo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From an...@apache.org
Subject svn commit: r1680192 - in /db/jdo/trunk/api/src/java/javax/jdo: ./ spi/
Date Tue, 19 May 2015 07:12:17 GMT
Author: andyj
Date: Tue May 19 07:12:16 2015
New Revision: 1680192

URL: http://svn.apache.org/r1680192
Log:
First set of javadoc fixes so that we can generate javadocs using JDK 1.8's extremely strict
generator

Modified:
    db/jdo/trunk/api/src/java/javax/jdo/AttributeConverter.java
    db/jdo/trunk/api/src/java/javax/jdo/Enhancer.java
    db/jdo/trunk/api/src/java/javax/jdo/FetchGroup.java
    db/jdo/trunk/api/src/java/javax/jdo/FetchPlan.java
    db/jdo/trunk/api/src/java/javax/jdo/JDOCanRetryException.java
    db/jdo/trunk/api/src/java/javax/jdo/JDOHelper.java
    db/jdo/trunk/api/src/java/javax/jdo/JDOQLTypedQuery.java
    db/jdo/trunk/api/src/java/javax/jdo/PersistenceManager.java
    db/jdo/trunk/api/src/java/javax/jdo/PersistenceManagerFactory.java
    db/jdo/trunk/api/src/java/javax/jdo/Query.java
    db/jdo/trunk/api/src/java/javax/jdo/Transaction.java
    db/jdo/trunk/api/src/java/javax/jdo/spi/JDOImplHelper.java
    db/jdo/trunk/api/src/java/javax/jdo/spi/JDOPermission.java
    db/jdo/trunk/api/src/java/javax/jdo/spi/PersistenceCapable.java

Modified: db/jdo/trunk/api/src/java/javax/jdo/AttributeConverter.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api/src/java/javax/jdo/AttributeConverter.java?rev=1680192&r1=1680191&r2=1680192&view=diff
==============================================================================
--- db/jdo/trunk/api/src/java/javax/jdo/AttributeConverter.java (original)
+++ db/jdo/trunk/api/src/java/javax/jdo/AttributeConverter.java Tue May 19 07:12:16 2015
@@ -30,13 +30,28 @@ package javax.jdo;
  */
 public interface AttributeConverter<A, D> {
 
-	/**
-	 * Converts the given persistent attribute value to its representation in the datastore.
-	 */
-	D convertToDatastore(A attributeValue);
+    /**
+     * Converts the given persistent attribute value to its representation in the datastore.
+     * @param attributeValue Value of attribute
+     * @return Value in datastore
+     */
+    D convertToDatastore(A attributeValue);
 
-	/**
-	 * Converts the given datastore value to its representation as a persistent attribute.
-	 */
-	A convertToAttribute(D datastoreValue);
+    /**
+     * Converts the given datastore value to its representation as a persistent attribute.
+     * @param datastoreValue Value in datastore
+     * @return Value in attribute
+     */
+    A convertToAttribute(D datastoreValue);
+
+	public static class NullAttributeConverter implements AttributeConverter<Object, Object>
+	{
+		public Object convertToDatastore(Object attributeValue) {
+			return null;
+		}
+
+		public Object convertToAttribute(Object datastoreValue) {
+			return null;
+		}
+	}
 }

Modified: db/jdo/trunk/api/src/java/javax/jdo/Enhancer.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api/src/java/javax/jdo/Enhancer.java?rev=1680192&r1=1680191&r2=1680192&view=diff
==============================================================================
--- db/jdo/trunk/api/src/java/javax/jdo/Enhancer.java (original)
+++ db/jdo/trunk/api/src/java/javax/jdo/Enhancer.java Tue May 19 07:12:16 2015
@@ -40,14 +40,14 @@ import javax.jdo.spi.I18NHelper;
 /**
  * Main class to invoke a JDO Enhancer.
  * The enhancer is invoked with the following command line:
- * <xmp>
- * java -cp <classpath> javax.jdo.Enhancer <options> <directory, file, or
resource names>
- * </xmp>
+ * <pre>
+ * java -cp {classpath} javax.jdo.Enhancer {options} {directory, file, or resource names}
+ * </pre>
  * &lt;classpath&gt; must contain the jdo specification jar, the implementation jar
and any 
  * implementation dependencies, the statically-compiled classes, and the jdo 
  * metadata files loadable as resources.
  * 
- * <p/>&lt;options&gt; include: 
+ * &lt;options&gt; include: 
  * <ul><li>? : print usage to stderr and exit
  * </li><li>-h : print usage to stderr and exit
  * </li><li>-help : print usage to stderr and exit

Modified: db/jdo/trunk/api/src/java/javax/jdo/FetchGroup.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api/src/java/javax/jdo/FetchGroup.java?rev=1680192&r1=1680191&r2=1680192&view=diff
==============================================================================
--- db/jdo/trunk/api/src/java/javax/jdo/FetchGroup.java (original)
+++ db/jdo/trunk/api/src/java/javax/jdo/FetchGroup.java Tue May 19 07:12:16 2015
@@ -151,6 +151,7 @@ public interface FetchGroup {
 
     /** 
      * Set the post-load property of this FetchGroup.
+     * @param postLoad Whether to post load this fetch group
      * @return the FetchGroup
      * @throws JDOUserException if the FetchGroup is unmodifiable
      * @since 2.2
@@ -182,11 +183,10 @@ public interface FetchGroup {
     FetchGroup addMembers(String... memberNames);
 
     /**
-     * Remove the member (field or property) from the set of members in this
-     * FetchGroup.
+     * Remove the member (field or property) from the set of members in this FetchGroup.
+     * @param memberName Name of the member of the class to remove from the FetchGroup.
      * @return the FetchGroup
-     * @throws JDOUserException if the parameter is not a member of the
-     * persistent type
+     * @throws JDOUserException if the parameter is not a member of the persistent type
      * @throws JDOUserException if the FetchGroup is unmodifiable
      * @since 2.2
      */
@@ -196,9 +196,9 @@ public interface FetchGroup {
      * Remove the member (field or property) from the set of members in this
      * FetchGroup. Duplicates in the parameter list are eliminated before
      * removing them from the membership.
+     * @param memberNames Member names of the class to remove from this FetchGroup.
      * @return the FetchGroup
-     * @throws JDOUserException if any parameter is not a member of the
-     * persistent type
+     * @throws JDOUserException if any parameter is not a member of the persistent type
      * @throws JDOUserException if the FetchGroup is unmodifiable
      * @since 2.2
      */
@@ -210,6 +210,7 @@ public interface FetchGroup {
      * resolves the category name to a set of members and then adds
      * the members as if {@link #addMembers} was called. After this
      * method executes, the category is not remembered.
+     * @param categoryName Category to add to this FetchGroup.
      * @return the FetchGroup
      * @throws JDOUserException if the FetchGroup is unmodifiable
      * @since 2.2
@@ -222,6 +223,7 @@ public interface FetchGroup {
      * resolves the category name to a set of members and then removes
      * the members as if {@link #removeMembers} was called. After this
      * method executes, the category is not remembered.
+     * @param categoryName Category to remove from this FetchGroup.
      * @return the FetchGroup
      * @throws JDOUserException if the FetchGroup is unmodifiable
      * @since 2.2

Modified: db/jdo/trunk/api/src/java/javax/jdo/FetchPlan.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api/src/java/javax/jdo/FetchPlan.java?rev=1680192&r1=1680191&r2=1680192&view=diff
==============================================================================
--- db/jdo/trunk/api/src/java/javax/jdo/FetchPlan.java (original)
+++ db/jdo/trunk/api/src/java/javax/jdo/FetchPlan.java Tue May 19 07:12:16 2015
@@ -88,6 +88,7 @@ public interface FetchPlan {
 
     /** 
      * Add the fetch group to the set of active fetch groups.
+     * @param fetchGroupName Name of the FetchGroup to add
      * @return the FetchPlan
      * @since 2.0
      */
@@ -95,6 +96,7 @@ public interface FetchPlan {
 
     /** 
      * Remove the fetch group from the set active fetch groups. 
+     * @param fetchGroupName Name of the FetchGroup to remove
      * @return the FetchPlan
      * @since 2.0
      */
@@ -164,6 +166,7 @@ public interface FetchPlan {
     /**
      * Set the roots for DetachAllOnCommit.
      * @param roots Collection of the detachment roots.
+     * @return This FetchPlan
      * @since 2.0
      */
     FetchPlan setDetachmentRoots(Collection roots);
@@ -178,6 +181,7 @@ public interface FetchPlan {
     /**
      * Set the root classes for DetachAllOnCommit.
      * @param rootClasses The root classes.
+     * @return This FetchPlan
      * @since 2.0
      */
     FetchPlan setDetachmentRootClasses(Class... rootClasses);
@@ -210,11 +214,14 @@ public interface FetchPlan {
     /**
      * Set options to be used during detachment. Options are {@link
      * #DETACH_LOAD_FIELDS} and {@link #DETACH_UNLOAD_FIELDS}.
+     * @param options Options for use during detachment.
+     * @return This FetchPlan
      */
     FetchPlan setDetachmentOptions(int options);
  
     /**
      * Get options used during detachment.
+     * @return Options to use during detachment.
      */
     int getDetachmentOptions();
   

Modified: db/jdo/trunk/api/src/java/javax/jdo/JDOCanRetryException.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api/src/java/javax/jdo/JDOCanRetryException.java?rev=1680192&r1=1680191&r2=1680192&view=diff
==============================================================================
--- db/jdo/trunk/api/src/java/javax/jdo/JDOCanRetryException.java (original)
+++ db/jdo/trunk/api/src/java/javax/jdo/JDOCanRetryException.java Tue May 19 07:12:16 2015
@@ -55,7 +55,7 @@ public class JDOCanRetryException extend
   
   /**
    * Constructs a new <code>JDOCanRetryException</code> with the specified detail
-   * message and nested <code>Throwable<code>s.
+   * message and nested <code>Throwable</code>s.
    * @param msg the detail message.
    * @param nested the nested <code>Throwable</code>.
    */

Modified: db/jdo/trunk/api/src/java/javax/jdo/JDOHelper.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api/src/java/javax/jdo/JDOHelper.java?rev=1680192&r1=1680191&r2=1680192&view=diff
==============================================================================
--- db/jdo/trunk/api/src/java/javax/jdo/JDOHelper.java (original)
+++ db/jdo/trunk/api/src/java/javax/jdo/JDOHelper.java Tue May 19 07:12:16 2015
@@ -779,11 +779,12 @@ public class JDOHelper implements Consta
      * <code>PersistenceManagerFactory</code> instance.  In this case, the 
      * properties of the returned instance must exactly match the requested 
      * properties.
-     * @return the <code>PersistenceManagerFactory</code>.
+     * @param overrides Overrides of properties
      * @param props a <code>Properties</code> instance with properties of the

      * <code>PersistenceManagerFactory</code>.
      * @param pmfClassLoader the class loader to use to load the
      * <code>PersistenceManagerFactory</code> class
+     * @return the <code>PersistenceManagerFactory</code>.
      * @throws JDOFatalUserException if
      * <ul><li>the pmfClassLoader passed is invalid; or 
      * </li><li>a valid class name cannot be obtained from
@@ -875,10 +876,9 @@ public class JDOHelper implements Consta
      * and comments.
      * @param url the URL of the services file
      * @return the name of the class contained in the file
-     * @throws java.io.IOException
+     * @throws java.io.IOException Throw if an error occurs on accessing this URL
      * @since 2.1
      */
-
     protected static String getClassNameFromURL (URL url) 
             throws IOException {
         InputStream is = openStream(url);
@@ -912,11 +912,11 @@ public class JDOHelper implements Consta
     }
 
     /**
-     * Returns a named {@link PersistenceManagerFactory} or persistence
-     * unit.
-     *
+     * Returns a named {@link PersistenceManagerFactory} or persistence unit.
      * @since 2.1
      * @see #getPersistenceManagerFactory(Map,String,ClassLoader,ClassLoader)
+     * @param name Name of the PMF
+     * @return PersistenceManagerFactory
      */
     public static PersistenceManagerFactory getPersistenceManagerFactory
         (String name) {
@@ -925,11 +925,12 @@ public class JDOHelper implements Consta
     }
 
     /**
-     * Returns a named {@link PersistenceManagerFactory} or persistence
-     * unit.
-     *
+     * Returns a named {@link PersistenceManagerFactory} or persistence unit.
      * @since 1.0
      * @see #getPersistenceManagerFactory(Map,String,ClassLoader,ClassLoader)
+     * @param name Name of the PMF
+     * @param loader ClassLoader to use
+     * @return PersistenceManagerFactory
      */
     public static PersistenceManagerFactory getPersistenceManagerFactory
         (String name, ClassLoader loader) {
@@ -938,11 +939,13 @@ public class JDOHelper implements Consta
     }
 
     /**
-     * Returns a named {@link PersistenceManagerFactory} or persistence
-     * unit.
-     *
+     * Returns a named {@link PersistenceManagerFactory} or persistence unit.
      * @since 2.0
      * @see #getPersistenceManagerFactory(Map,String,ClassLoader,ClassLoader)
+     * @param name Name of the PMF
+     * @param resourceLoader ClassLoader to use for loading resources
+     * @param pmfLoader ClassLoader to use for loading the PMF
+     * @return PersistenceManagerFactory
      */
     public static PersistenceManagerFactory getPersistenceManagerFactory
         (String name, ClassLoader resourceLoader, ClassLoader pmfLoader) {
@@ -952,11 +955,12 @@ public class JDOHelper implements Consta
     }
 
     /**
-     * Returns a named {@link PersistenceManagerFactory} or persistence
-     * unit.
-     *
+     * Returns a named {@link PersistenceManagerFactory} or persistence unit.
      * @since 2.1
      * @see #getPersistenceManagerFactory(Map,String,ClassLoader,ClassLoader)
+     * @param name Name of the PMF
+     * @param overrides Property overrides
+     * @return PersistenceManagerFactory
      */
     public static PersistenceManagerFactory getPersistenceManagerFactory
             (Map<?, ?> overrides, String name) {
@@ -966,11 +970,13 @@ public class JDOHelper implements Consta
     }
 
     /**
-     * Returns a named {@link PersistenceManagerFactory} or persistence
-     * unit.
-     *
+     * Returns a named {@link PersistenceManagerFactory} or persistence unit.
      * @since 2.1
      * @see #getPersistenceManagerFactory(Map,String,ClassLoader,ClassLoader)
+     * @param overrides Property overrides
+     * @param name Name of the PMF
+     * @param resourceLoader ClassLoader to use for loading resources
+     * @return The PMF
      */
     public static PersistenceManagerFactory getPersistenceManagerFactory
             (Map<?, ?> overrides, String name, ClassLoader resourceLoader) {
@@ -1055,8 +1061,7 @@ public class JDOHelper implements Consta
      * {@link PersistenceManagerFactory} or
      * <code>javax.persistence.EntityManagerFactory</code> classes
      * @return the {@link PersistenceManagerFactory} with properties in the
-     * given resource, with the given name, or with the given persitence unit
-     * name
+     * given resource, with the given name, or with the given persitence unit name
      * @see Constants#ANONYMOUS_PERSISTENCE_MANAGER_FACTORY_NAME
      */
     public static PersistenceManagerFactory getPersistenceManagerFactory(
@@ -1237,12 +1242,14 @@ public class JDOHelper implements Consta
     /**
      * @see #getNamedPMFProperties(String,ClassLoader,String)
      * @since 2.1
+     * @param name Name of the PMF
+     * @param resourceLoader ClassLoader to use for loading resources
+     * @return The properties for this PMF
      */
     protected static Map<Object,Object> getPropertiesFromJdoconfig(
             String name,
             ClassLoader resourceLoader) {
-        return getNamedPMFProperties(
-            name, resourceLoader, JDOCONFIG_RESOURCE_NAME);
+        return getNamedPMFProperties(name, resourceLoader, JDOCONFIG_RESOURCE_NAME);
     }
 
     /**
@@ -1388,17 +1395,15 @@ public class JDOHelper implements Consta
     }
 
 
-    /** Reads JDO configuration file, creates a Map for each
+    /**
+     * Reads JDO configuration file, creates a Map for each
      * persistence-manager-factory, then returns the map.
-     * @param url URL of a JDO configuration file compliant with
-     * javax/jdo/jdoconfig.xsd.
+     * @param url URL of a JDO configuration file compliant with javax/jdo/jdoconfig.xsd.
      * @param requestedPMFName The name of the requested
-     * persistence unit (allows for fail-fast).
-     * @param factory The <code>DocumentBuilderFactory</code> to use for XML
-     * parsing.
-     * @return a Map<String,Map> holding persistence unit configurations; for
-     * the anonymous persistence unit, the
-     * value of the String key is the empty string, "".
+     *   persistence unit (allows for fail-fast).
+     * @param factory The <code>DocumentBuilderFactory</code> to use for XML
parsing.
+     * @return a Map&lt;String,Map&gt; holding persistence unit configurations; for
the
+     *   anonymous persistence unit, the value of the String key is the empty string, "".
      */
     protected static Map<String,Map<Object,Object>> readNamedPMFProperties(
             URL url,
@@ -1980,11 +1985,13 @@ public class JDOHelper implements Consta
         }
     }
 
-    /** Get resources of the resource loader. 
+    /**
+     * Get resources of the resource loader. 
      * Perform this operation in a doPrivileged block.
-     * @param resourceLoader
-     * @param resourceName
+     * @param resourceLoader ClassLoader to use for loading resources
+     * @param resourceName Name of the resource
      * @return the resources
+     * @throws IOException if an error occurs accessing the resources
      */
     protected static Enumeration<URL> getResources(
             final ClassLoader resourceLoader, 
@@ -2003,9 +2010,9 @@ public class JDOHelper implements Consta
         }
     }
 
-    /** Get the named class.
+    /** 
+     * Get the named class.
      * Perform this operation in a doPrivileged block.
-     * 
      * @param name the name of the class
      * @param init whether to initialize the class
      * @param loader which class loader to use

Modified: db/jdo/trunk/api/src/java/javax/jdo/JDOQLTypedQuery.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api/src/java/javax/jdo/JDOQLTypedQuery.java?rev=1680192&r1=1680191&r2=1680192&view=diff
==============================================================================
--- db/jdo/trunk/api/src/java/javax/jdo/JDOQLTypedQuery.java (original)
+++ db/jdo/trunk/api/src/java/javax/jdo/JDOQLTypedQuery.java Tue May 19 07:12:16 2015
@@ -61,6 +61,7 @@ public interface JDOQLTypedQuery<T>
      * @param name Name of the parameter
      * @param type Java type of the parameter
      * @return Expression for the parameter
+     * @param <P> type for the parameter
      */
     <P> Expression<P> parameter(String name, Class<P> type);
 
@@ -133,6 +134,7 @@ public interface JDOQLTypedQuery<T>
      * @param name Name of the variable
      * @param type Type of the variable
      * @return Expression for the variable
+     * @param <V> type for the variable
      */
     <V> Expression<V> variable(String name, Class<V> type);
 
@@ -280,14 +282,12 @@ public interface JDOQLTypedQuery<T>
      * Method to execute the query where there are (potentially) multiple rows and we are
returning
      * the candidate type.
      * @return The results
-     * @param <T> result type
      */
     List<T> executeList();
 
     /**
      * Method to execute the query where there is a single row and we are returning the candidate
type.
      * @return The result
-     * @param <T> result type
      */
     T executeUnique();
 

Modified: db/jdo/trunk/api/src/java/javax/jdo/PersistenceManager.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api/src/java/javax/jdo/PersistenceManager.java?rev=1680192&r1=1680191&r2=1680192&view=diff
==============================================================================
--- db/jdo/trunk/api/src/java/javax/jdo/PersistenceManager.java (original)
+++ db/jdo/trunk/api/src/java/javax/jdo/PersistenceManager.java Tue May 19 07:12:16 2015
@@ -153,7 +153,7 @@ public interface PersistenceManager exte
 
     /**
      * Refreshes all instances in the exception that failed verification.
-     *
+     * @param jdoe The exception defining object(s) to be refreshed
      * @since 2.0
      */
     void refreshAll (JDOException jdoe);
@@ -263,14 +263,17 @@ public interface PersistenceManager exte
      * @param subclasses whether to include instances of subclasses
      * @return an <code>Extent</code> of the specified <code>Class</code>
      * @see Query
+     * @param <T> Type for the candidate of the Extent
      */
     <T> Extent<T> getExtent (Class<T> persistenceCapableClass, boolean
subclasses);
 
     /**
-     * Equivalent to <code>getExtent (persistenceCapableClass,
-     * true)</code>.
+     * Equivalent to <code>getExtent (persistenceCapableClass, true)</code>.
      * @see #getExtent(Class,boolean)
      * @since 2.0
+     * @param persistenceCapableClass Candidate class for the extent
+     * @return an <code>Extent</code> of the specified <code>Class</code>
+     * @param <T> Type for the candidate of the Extent
      */
     <T> Extent<T> getExtent (Class<T> persistenceCapableClass);
 
@@ -346,12 +349,13 @@ public interface PersistenceManager exte
      * an object representation of a single field identity key
      * @return the corresponding persistent instance
      * @since 2.0
+     * @param <T> Type of the persistable object being retrieved
      */
     <T> T getObjectById (Class<T> cls, Object key);
 
     /**
      * Looks up the instance corresponding to the specified oid. This is
-     * equivalent to <code>getObjectById(oid, true);
+     * equivalent to <code>getObjectById(oid, true);</code>
      * @param oid The object id of the object to load
      * @return the corresponding persistent instance
      */
@@ -524,6 +528,7 @@ public interface PersistenceManager exte
      * @return the parameter instance for parameters in the transient or
      * persistent state, or the corresponding persistent instance 
      * for detached parameter instances
+     * @param <T> Type of the persistable object
      */
     <T> T makePersistent (T pc);
     
@@ -534,6 +539,7 @@ public interface PersistenceManager exte
      * for detached parameter instances, in the same order as in the 
      * parameter array
      * @see #makePersistent(Object pc)
+     * @param <T> Type of the persistable object
      */
     <T> T[] makePersistentAll (T... pcs);
     
@@ -544,6 +550,7 @@ public interface PersistenceManager exte
      * for detached parameter instances, with an iteration in the same order
      * as in the parameter Collection
      * @see #makePersistent(Object pc)
+     * @param <T> Type of the persistable object
      */
     <T> Collection<T> makePersistentAll (Collection<T> pcs);
     
@@ -984,7 +991,7 @@ public interface PersistenceManager exte
     * persistent instances transition to transient; and detachable
     * instances can be serialized as detached instances. Transient
     * transactional instances are unaffected by this flag.
-    *
+    * @param flag Flag for whether to detach all on commit
     * @see #getDetachAllOnCommit()
     * @since 2.0
     */
@@ -1005,7 +1012,7 @@ public interface PersistenceManager exte
     * instances are attached directly and change their state from
     * detached-clean to persistent-clean or from detached-dirty to
     * persistent-dirty.
-    *
+    * @param flag Flag for whether to copy on attach
     * @see #getCopyOnAttach()
     * @since 2.1
     */
@@ -1021,6 +1028,7 @@ public interface PersistenceManager exte
      * @return the detached instance
      * @see #detachCopyAll(Object[])
      * @since 2.0
+     * @param <T> Type of the persistable object
      */
     <T> T detachCopy (T pc);
 
@@ -1034,6 +1042,7 @@ public interface PersistenceManager exte
      * @return the detached instances
      * @see #detachCopyAll(Object[])
      * @since 2.0
+     * @param <T> Type of the persistable objects
      */
     <T> Collection<T> detachCopyAll (Collection<T> pcs);
 
@@ -1060,12 +1069,16 @@ public interface PersistenceManager exte
      * @see #makePersistentAll(Object[])
      * @see #getFetchPlan
      * @since 2.0
+     * @param <T> Type of the persistable object
      */
     <T> T[] detachCopyAll (T... pcs);
 
     /**
      * Put the specified key-value pair into the map of user objects.
      * @since 2.0
+     * @param key Key to store the user object under
+     * @param val User object to store
+     * @return The previous object under this key
      */
     Object putUserObject (Object key, Object val);
 
@@ -1080,6 +1093,7 @@ public interface PersistenceManager exte
     /**
      * Remove the specified key and its value from the map of user objects.
      * @param key the key of the object to be removed
+     * @return The user object that was removed
      * @since 2.0
      */
     Object removeUserObject (Object key);
@@ -1140,6 +1154,7 @@ public interface PersistenceManager exte
      * or a concrete or abstract class that is declared in the metadata.
      * @return the created instance
      * @since 2.0
+     * @param <T> Type of the persistable object
      */
     <T> T newInstance (Class<T> pcClass);
 

Modified: db/jdo/trunk/api/src/java/javax/jdo/PersistenceManagerFactory.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api/src/java/javax/jdo/PersistenceManagerFactory.java?rev=1680192&r1=1680191&r2=1680192&view=diff
==============================================================================
--- db/jdo/trunk/api/src/java/javax/jdo/PersistenceManagerFactory.java (original)
+++ db/jdo/trunk/api/src/java/javax/jdo/PersistenceManagerFactory.java Tue May 19 07:12:16
2015
@@ -379,7 +379,7 @@ public interface PersistenceManagerFacto
     * instances are attached directly and change their state from
     * detached-clean to persistent-clean or from detached-dirty to
     * persistent-dirty.
-    *
+    * @param flag Whether we should copy on attach
     * @see #getCopyOnAttach()
     * @since 2.1
     */
@@ -483,7 +483,7 @@ public interface PersistenceManagerFacto
      * <P>ReadOnly set to <code>false</code> specifies that no updates
      * can be performed to the datastore, and if updates are attempted
      * a JDOReadOnlyException is thrown.
-     *
+     * @param flag whether we should consider this datastore read-only
      * @see #getReadOnly()
      * @since 2.2
      */
@@ -773,6 +773,7 @@ public interface PersistenceManagerFacto
      * metadata defined for that class/interface.
      * If there is no metadata for the specified class/interface, or the parameter is null,
      * then null will be returned.
+     * @param className Name of the class to get metadata for
      * @return The metadata
      * @since 3.0
      */

Modified: db/jdo/trunk/api/src/java/javax/jdo/Query.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api/src/java/javax/jdo/Query.java?rev=1680192&r1=1680191&r2=1680192&view=diff
==============================================================================
--- db/jdo/trunk/api/src/java/javax/jdo/Query.java (original)
+++ db/jdo/trunk/api/src/java/javax/jdo/Query.java Tue May 19 07:12:16 2015
@@ -449,7 +449,7 @@ public interface Query extends AutoClose
      * and is of the type (treating wrapper types equivalent to primitive 
      * types) of the result expression; 
      * <li>or if no public field matches the name and type, a public 
-     * <code>set</code method that returns void and matches the name of the 
+     * <code>set</code> method that returns void and matches the name of the

      * result expression and takes a single parameter which is the 
      * exact type of the result expression;
      * <li>or if neither of the above applies,a public method must be found 
@@ -460,7 +460,7 @@ public interface Query extends AutoClose
      * </ul>
      * </ul>
      * Portable result classes do not invoke any persistence behavior 
-     * during their no-args constructor or <code>set</code methods.
+     * during their no-args constructor or <code>set</code> methods.
      * @param cls the result class
      * @since 2.0
      */
@@ -774,6 +774,7 @@ public interface Query extends AutoClose
      * throw JDOUnsupportedOptionException.
      * If the cancellation fails (e.g in the underlying datastore) then this will throw
      * a JDOException.
+     * @param thread The thread to cancel
      * @since 3.0
      */
     void cancel(Thread thread);

Modified: db/jdo/trunk/api/src/java/javax/jdo/Transaction.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api/src/java/javax/jdo/Transaction.java?rev=1680192&r1=1680191&r2=1680192&view=diff
==============================================================================
--- db/jdo/trunk/api/src/java/javax/jdo/Transaction.java (original)
+++ db/jdo/trunk/api/src/java/javax/jdo/Transaction.java Tue May 19 07:12:16 2015
@@ -83,7 +83,7 @@ public interface Transaction
      * Sets the rollback-only status of the transaction to <code>true</code>.
      * After this flag is set to <code>true</code>, the transaction 
      * can no longer be committed, and any attempt to commit the 
-     * transaction will throw <code>JDOFatalDataStoreException<code>.
+     * transaction will throw <code>JDOFatalDataStoreException</code>.
      * @since 2.0
      */
     void setRollbackOnly();

Modified: db/jdo/trunk/api/src/java/javax/jdo/spi/JDOImplHelper.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api/src/java/javax/jdo/spi/JDOImplHelper.java?rev=1680192&r1=1680191&r2=1680192&view=diff
==============================================================================
--- db/jdo/trunk/api/src/java/javax/jdo/spi/JDOImplHelper.java (original)
+++ db/jdo/trunk/api/src/java/javax/jdo/spi/JDOImplHelper.java Tue May 19 07:12:16 2015
@@ -1154,12 +1154,8 @@ public class JDOImplHelper extends java.
      * beginning with
      * {@link Constants#PROPERTY_PREFIX_INSTANCE_LIFECYCLE_LISTENER} or not
      * beginning with {@link Constants#JAVAX_JDO_PREFIX}.
-     * 
-     * @param properties
-     *            The properties to examine.
-     * 
+     * @param properties The properties to examine.
      * @see Constants#JAVAX_JDO_PREFIX
-     * @see JDOHelper#USER_CONFIGURABLE_STANDARD_PROPERTIES
      * @since 3.1
      */
     public static void assertOnlyKnownStandardProperties(Map<?, ?> properties) {

Modified: db/jdo/trunk/api/src/java/javax/jdo/spi/JDOPermission.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api/src/java/javax/jdo/spi/JDOPermission.java?rev=1680192&r1=1680191&r2=1680192&view=diff
==============================================================================
--- db/jdo/trunk/api/src/java/javax/jdo/spi/JDOPermission.java (original)
+++ db/jdo/trunk/api/src/java/javax/jdo/spi/JDOPermission.java Tue May 19 07:12:16 2015
@@ -28,15 +28,13 @@ package javax.jdo.spi;
  * The following table
  * provides a summary description of what each named permission allows,
  * and discusses the risks of granting code the permission.
- * <P>
  *
- * <table border=1 cellpadding=5>
+ * <table border=1 cellpadding=5 summary="">
  * <tr>
  * <th>Permission Target Name</th>
  * <th>What the Permission Allows</th>
  * <th>Risks of Allowing this Permission</th>
  * </tr>
- *
  * <tr>
  *   <td><code>setStateManager</code></td>
  *   <td>This allows setting the <code>StateManager</code> for an instance
of 
@@ -46,7 +44,6 @@ package javax.jdo.spi;
  *   <td>This is dangerous in that information (possibly confidential) 
  *   normally unavailable would be accessible to malicious code.</td>
  * </tr>
- *
  * <tr>
  *   <td><code>getMetadata</code></td>
  *   <td>This allows getting metadata for any <code>PersistenceCapable</code>

@@ -54,7 +51,6 @@ package javax.jdo.spi;
  *   <td>This is dangerous in that metadata information (possibly confidential) 
  *   normally unavailable would be accessible to malicious code.</td>
  * </tr>
- *
  * <tr>
  *   <td><code>manageMetadata</code></td>
  *   <td>This allows managing metadata for any <code>PersistenceCapable</code>

@@ -63,7 +59,6 @@ package javax.jdo.spi;
  *   normally unavailable would be manageable (modifiable) by malicious code.
  *   </td>
  * </tr>
- *
  * <tr>
  *   <td><code>closePersistenceManagerFactory</code></td>
  *   <td>This allows closing a <code>PersistenceManagerFactory</code>,
@@ -72,7 +67,6 @@ package javax.jdo.spi;
  *       <code>PersistenceManagerFactory</code> would be releaseable by
  *       malicious code.</td>  
  * </tr>
- *
  * </table>
  *
  * @see java.security.Permission

Modified: db/jdo/trunk/api/src/java/javax/jdo/spi/PersistenceCapable.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api/src/java/javax/jdo/spi/PersistenceCapable.java?rev=1680192&r1=1680191&r2=1680192&view=diff
==============================================================================
--- db/jdo/trunk/api/src/java/javax/jdo/spi/PersistenceCapable.java (original)
+++ db/jdo/trunk/api/src/java/javax/jdo/spi/PersistenceCapable.java Tue May 19 07:12:16 2015
@@ -389,14 +389,13 @@ public interface PersistenceCapable {
      * example, an ObjectId class that has three key fields <code>(int id,
      * String name, and Float salary)</code> would have the method generated:
      * <code>
-     * <P>void jdoCopyKeyFieldsToObjectId
-     * <P>(ObjectIdFieldSupplier fm, Object objectId) {
-     * <P>EmployeeKey oid = (EmployeeKey)objectId;
-     * <P>oid.id = fm.fetchIntField (0);
-     * <P>oid.name = fm.fetchStringField (1);
-     * <P>oid.salary = fm.fetchObjectField (2);
-     * <P>}
-     * </code>
+     * void jdoCopyKeyFieldsToObjectId
+     * (ObjectIdFieldSupplier fm, Object objectId) {
+     * EmployeeKey oid = (EmployeeKey)objectId;
+     * oid.id = fm.fetchIntField (0);
+     * oid.name = fm.fetchStringField (1);
+     * oid.salary = fm.fetchObjectField (2);
+     * }</code>
      * <P>The implementation is responsible for implementing the
      * <code>ObjectIdFieldSupplier</code> to produce the values 
      * for the key fields.
@@ -414,14 +413,12 @@ public interface PersistenceCapable {
      * example, an ObjectId class that has three key fields <code>(int id,
      * String name, and Float salary)</code> would have the method generated:
      * <code>
-     * <P>void copyKeyFieldsFromObjectId
-     * <P>        (ObjectIdFieldConsumer fm, Object objectId) {
-     * <P>     EmployeeKey oid = (EmployeeKey)objectId;
-     * <P>     fm.storeIntField (0, oid.id);
-     * <P>     fm.storeStringField (1, oid.name);
-     * <P>     fm.storeObjectField (2, oid.salary);
-     * <P>}
-     * </code>
+     * void copyKeyFieldsFromObjectId(ObjectIdFieldConsumer fm, Object objectId) {
+     *     EmployeeKey oid = (EmployeeKey)objectId;
+     *     fm.storeIntField (0, oid.id);
+     *     fm.storeStringField (1, oid.name);
+     *     fm.storeObjectField (2, oid.salary);
+     * }</code>
      * <P>The implementation is responsible for implementing the
      * <code>ObjectIdFieldConsumer</code> to store the values for the 
      * key fields.



Mime
View raw message