JDODetachedFieldAccessException without a detail message.
+ * Constructs a new JDODetachedFieldAccessException without a
+ * detail message.
* @since 2.0
*/
public JDODetachedFieldAccessException() {
@@ -38,7 +39,8 @@
/**
- * Constructs a new JDODetachedFieldAccessException with the specified detail message.
+ * Constructs a new JDODetachedFieldAccessException with the
+ * specified detail message.
* @param msg the detail message.
* @since 2.0
*/
Index: src/java/javax/jdo/JDOOptimisticVerificationException.java
===================================================================
--- src/java/javax/jdo/JDOOptimisticVerificationException.java (Revision 389512)
+++ src/java/javax/jdo/JDOOptimisticVerificationException.java (Arbeitskopie)
@@ -31,22 +31,24 @@
public class JDOOptimisticVerificationException extends JDOFatalDataStoreException {
/**
- * Constructs a new JDOOptimisticVerificationException without a detail message.
+ * Constructs a new JDOOptimisticVerificationException without a
+ * detail message.
*/
public JDOOptimisticVerificationException() {
}
/**
- * Constructs a new JDOOptimisticVerificationException with the specified detail message.
+ * Constructs a new JDOOptimisticVerificationException with the
+ * specified detail message.
* @param msg the detail message.
*/
public JDOOptimisticVerificationException(String msg) {
super(msg);
}
- /** Constructs a new JDOOptimisticVerificationException with the specified detail message
- * and failed object.
+ /** Constructs a new JDOOptimisticVerificationException with the
+ * specified detail message and failed object.
* @param msg the detail message.
* @param failed the failed object.
*/
@@ -55,8 +57,8 @@
}
/**
- * Constructs a new JDOOptimisticVerificationException with the specified
- * detail message and nested Throwables.
+ * Constructs a new JDOOptimisticVerificationException with the
+ * specified detail message and nested Throwables.
* @param msg the detail message.
* @param nested the nested Throwable[].
*/
Index: src/java/javax/jdo/listener/DetachCallback.java
===================================================================
--- src/java/javax/jdo/listener/DetachCallback.java (Revision 389512)
+++ src/java/javax/jdo/listener/DetachCallback.java (Arbeitskopie)
@@ -21,8 +21,6 @@
package javax.jdo.listener;
-import javax.jdo.PersistenceManager;
-
/**
* This interface is used to notify instances of detach events.
* @version 2.0
@@ -32,7 +30,7 @@
/**
* This method is called during the execution of
- * {@link PersistenceManager#detachCopy} on the
+ * {@link javax.jdo.PersistenceManager#detachCopy} on the
* persistent instance before the copy is made.
* @since 2.0
*/
@@ -40,7 +38,7 @@
/**
* This method is called during the execution of
- * {@link PersistenceManager#detachCopy} on the
+ * {@link javax.jdo.PersistenceManager#detachCopy} on the
* detached instance after the copy is made.
* @param detached The corresponding (attached) persistent instance.
* @since 2.0
Index: src/java/javax/jdo/listener/LoadLifecycleListener.java
===================================================================
--- src/java/javax/jdo/listener/LoadLifecycleListener.java (Revision 389512)
+++ src/java/javax/jdo/listener/LoadLifecycleListener.java (Arbeitskopie)
@@ -38,4 +38,4 @@
* @since 2.0
*/
void postLoad (InstanceLifecycleEvent event);
-}
\ No newline at end of file
+}
Index: src/java/javax/jdo/listener/ClearLifecycleListener.java
===================================================================
--- src/java/javax/jdo/listener/ClearLifecycleListener.java (Revision 389512)
+++ src/java/javax/jdo/listener/ClearLifecycleListener.java (Arbeitskopie)
@@ -55,4 +55,4 @@
* @since 2.0
*/
void postClear (InstanceLifecycleEvent event);
-}
\ No newline at end of file
+}
Index: src/java/javax/jdo/listener/DetachLifecycleListener.java
===================================================================
--- src/java/javax/jdo/listener/DetachLifecycleListener.java (Revision 389512)
+++ src/java/javax/jdo/listener/DetachLifecycleListener.java (Arbeitskopie)
@@ -21,8 +21,6 @@
package javax.jdo.listener;
-import javax.jdo.PersistenceManager;
-
/**
* This interface is implemented by listeners to be notified of
* detach events.
@@ -34,7 +32,7 @@
/**
* This method is called during the execution of
- * {@link PersistenceManager#detachCopy} before the
+ * {@link javax.jdo.PersistenceManager#detachCopy} before the
* detached copy is made. It is called before the method
* {@link DetachCallback#jdoPreDetach} is called on the
* instance to be detached.
@@ -45,7 +43,7 @@
/**
* This method is called during the execution of
- * {@link PersistenceManager#detachCopy} after the
+ * {@link javax.jdo.PersistenceManager#detachCopy} after the
* detached copy is made. It is called after the method
* {@link DetachCallback#jdoPreDetach} is called on
* the detached instance.
Index: src/java/javax/jdo/listener/AttachCallback.java
===================================================================
--- src/java/javax/jdo/listener/AttachCallback.java (Revision 389512)
+++ src/java/javax/jdo/listener/AttachCallback.java (Arbeitskopie)
@@ -21,8 +21,6 @@
package javax.jdo.listener;
-import javax.jdo.PersistenceManager;
-
/**
* This interface is used to notify instances of attach events.
* @version 2.0
@@ -32,7 +30,7 @@
/**
* This method is called during the execution of
- * {@link PersistenceManager#makePersistent} on the detached instance
+ * {@link javax.jdo.PersistenceManager#makePersistent} on the detached instance
* before the copy is made.
* @since 2.0
*/
@@ -40,10 +38,10 @@
/**
* This method is called during the execution of
- * {@link PersistenceManager#makePersistent} on the persistent
+ * {@link javax.jdo.PersistenceManager#makePersistent} on the persistent
* instance after the copy is made.
* @param attached The corresponding (non-attached) instance that was
- * attached in the call to {@link PersistenceManager#makePersistent}.
+ * attached in the call to {@link javax.jdo.PersistenceManager#makePersistent}.
* @since 2.0
*/
public void jdoPostAttach(Object attached);
Index: src/java/javax/jdo/listener/DirtyLifecycleListener.java
===================================================================
--- src/java/javax/jdo/listener/DirtyLifecycleListener.java (Revision 389512)
+++ src/java/javax/jdo/listener/DirtyLifecycleListener.java (Arbeitskopie)
@@ -45,4 +45,4 @@
* @since 2.0
*/
void postDirty (InstanceLifecycleEvent event);
-}
\ No newline at end of file
+}
Index: src/java/javax/jdo/listener/StoreLifecycleListener.java
===================================================================
--- src/java/javax/jdo/listener/StoreLifecycleListener.java (Revision 389512)
+++ src/java/javax/jdo/listener/StoreLifecycleListener.java (Arbeitskopie)
@@ -21,9 +21,6 @@
package javax.jdo.listener;
-import javax.jdo.PersistenceManager;
-import javax.jdo.Transaction;
-
/**
* This interface is implemented by listeners to be notified of
* store events.
@@ -34,9 +31,9 @@
extends InstanceLifecycleListener {
/**
- * Invoked whenever a persistent instance is stored, for example
- * during {@link PersistenceManager#flush} or {@link
- * Transaction#commit}. It is called before the
+ * Invoked whenever a persistent instance is stored, for example during
+ * {@link javax.jdo.PersistenceManager#flush} or
+ * {@link javax.jdo.Transaction#commit}. It is called before the
* method {@link StoreCallback#jdoPreStore} is invoked.
* @param event the store event.
* @since 2.0
@@ -44,12 +41,12 @@
void preStore (InstanceLifecycleEvent event);
/**
- * Invoked whenever a persistent instance is stored, for example
- * during {@link PersistenceManager#flush} or {@link
- * Transaction#commit}. It is called after the
+ * Invoked whenever a persistent instance is stored, for example during
+ * {@link javax.jdo.PersistenceManager#flush} or
+ * {@link javax.jdo.Transaction#commit}. It is called after the
* field values have been stored.
* @param event the store event.
* @since 2.0
*/
void postStore (InstanceLifecycleEvent event);
-}
\ No newline at end of file
+}
Index: src/java/javax/jdo/listener/InstanceLifecycleEvent.java
===================================================================
--- src/java/javax/jdo/listener/InstanceLifecycleEvent.java (Revision 389512)
+++ src/java/javax/jdo/listener/InstanceLifecycleEvent.java (Arbeitskopie)
@@ -119,7 +119,8 @@
* getPersistentInstance() and
* getDetachedInstance() be used instead.
*
- * @return The detached instance for preDetach and postAttach, the persistent instance otherwise.
+ * @return The detached instance for preDetach and postAttach,
+ * the persistent instance otherwise.
*
* @since 2.0
* @see #getPersistentInstance()
@@ -133,7 +134,8 @@
/**
* Returns the persistent instance involved in the event.
*
- * @return The persistent instance involved in the event, or null if there was none.
+ * @return The persistent instance involved in the event, or null if there
+ * was none.
*
* @see "Section 12.15, Java Data Objects 2.0 Specification"
*/
@@ -185,4 +187,4 @@
throws java.io.IOException {
throw new java.io.NotSerializableException();
}
-}
\ No newline at end of file
+}
Index: src/java/javax/jdo/listener/DeleteLifecycleListener.java
===================================================================
--- src/java/javax/jdo/listener/DeleteLifecycleListener.java (Revision 389512)
+++ src/java/javax/jdo/listener/DeleteLifecycleListener.java (Arbeitskopie)
@@ -21,8 +21,6 @@
package javax.jdo.listener;
-import javax.jdo.PersistenceManager;
-
/**
* This interface is implemented by listeners to be notified of
* delete events.
@@ -34,8 +32,8 @@
/**
* Invoked whenever a persistent instance is deleted, for example
- * during {@link PersistenceManager#deletePersistent}. Access to field
- * values within this call are permitted.
+ * during {@link javax.jdo.PersistenceManager#deletePersistent}.
+ * Access to field values within this call are permitted.
* This method is called before the instance callback * {@link DeleteCallback#jdoPreDelete}. * @param event the delete event. @@ -45,11 +43,11 @@ /** * Invoked whenever a persistent instance is deleted, for example - * during {@link PersistenceManager#deletePersistent}. + * during {@link javax.jdo.PersistenceManager#deletePersistent}. *
This method is called after the instance transitions
* to persistent-deleted. Access to field values is not permitted.
* @param event the delete event.
* @since 2.0
*/
void postDelete (InstanceLifecycleEvent event);
-}
\ No newline at end of file
+}
Index: src/java/javax/jdo/listener/CreateLifecycleListener.java
===================================================================
--- src/java/javax/jdo/listener/CreateLifecycleListener.java (Revision 389512)
+++ src/java/javax/jdo/listener/CreateLifecycleListener.java (Arbeitskopie)
@@ -21,8 +21,6 @@
package javax.jdo.listener;
-import javax.jdo.PersistenceManager;
-
/**
* This interface is implemented by listeners to be notified of
* create events.
@@ -34,10 +32,10 @@
/**
* Invoked whenever an instance is made persistent via a
- * call to {@link PersistenceManager#makePersistent} or during
+ * call to {@link javax.jdo.PersistenceManager#makePersistent} or during
* persistence by reachability.
* @param event the create event.
* @since 2.0
*/
void postCreate (InstanceLifecycleEvent event);
-}
\ No newline at end of file
+}
Index: src/java/javax/jdo/listener/InstanceLifecycleListener.java
===================================================================
--- src/java/javax/jdo/listener/InstanceLifecycleListener.java (Revision 389512)
+++ src/java/javax/jdo/listener/InstanceLifecycleListener.java (Arbeitskopie)
@@ -31,4 +31,4 @@
* @since 2.0
*/
public interface InstanceLifecycleListener {
-}
\ No newline at end of file
+}
Index: src/java/javax/jdo/listener/AttachLifecycleListener.java
===================================================================
--- src/java/javax/jdo/listener/AttachLifecycleListener.java (Revision 389512)
+++ src/java/javax/jdo/listener/AttachLifecycleListener.java (Arbeitskopie)
@@ -21,8 +21,6 @@
package javax.jdo.listener;
-import javax.jdo.PersistenceManager;
-
/**
* This interface is implemented by listeners to be notified of
* attach events.
@@ -34,8 +32,8 @@
/**
* This method is called before a detached instance is attached, via the
- * {@link PersistenceManager#makePersistent} method. The source instance
- * is the detached instance. This method is called before the
+ * {@link javax.jdo.PersistenceManager#makePersistent} method. The source
+ * instance is the detached instance. This method is called before the
* corresponding {@link AttachCallback#jdoPreAttach} on the detached
* instance.
* @param event the attach event.
@@ -45,7 +43,7 @@
/**
* This method is called after a detached instance is attached, via the
- * {@link PersistenceManager#makePersistent} method. The source
+ * {@link javax.jdo.PersistenceManager#makePersistent} method. The source
* instance is the corresponding persistent instance in the cache; the
* target instance is the detached instance. This method is called after
* the corresponding {@link AttachCallback#jdoPostAttach} on the
Index: src/java/javax/jdo/Query.java
===================================================================
--- src/java/javax/jdo/Query.java (Revision 389512)
+++ src/java/javax/jdo/Query.java (Arbeitskopie)
@@ -28,14 +28,14 @@
* instances, values, and aggregate data
* from the data store.
*
- * The {@link PersistenceManager} is the factory for Query instances. There
- * may be many Query instances associated with a PersistenceManager.
- * Multiple queries might be executed simultaneously by different threads, but the
- * implementation might choose to execute them serially. In either case, the
- * implementation must be thread safe.
+ * The {@link PersistenceManager} is the factory for Query instances.
+ * There may be many Query instances associated with a
+ * PersistenceManager. Multiple queries might be executed
+ * simultaneously by different threads, but the implementation might choose to
+ * execute them serially. In either case, the implementation must be thread safe.
*
- *
There are three required elements in a Query: the class of the results,
- * the candidate collection of instances, and the filter.
+ *
There are three required elements in a Query: the class of the
+ * results, the candidate collection of instances, and the filter.
*
*
There are optional elements: parameter declarations, variable
* declarations, import statements, ordering and grouping specifications,
@@ -78,8 +78,8 @@
* based on the parameters given. They return a single instance or a
* List of result class instances which the
* user can iterate to get results. The signature
- * of the execute methods specifies that they return an Object which
- * must be cast to the appropriate result by the user.
+ * of the execute methods specifies that they return an
+ * Object which must be cast to the appropriate result by the user.
*
Any parameters passed to the execute methods are used only for
* this execution, and are not remembered for future execution.
* @version 2.0
@@ -143,7 +143,8 @@
* then it defaults to "true", which has the effect of filtering
* the input Collection only for class type.
*
An element of the candidate collection is returned in the result if: - *
Class of the Query; and
+ * Class
+ * of the Query; and
* true.
* Date fields and Date
- * parameters are valid.
+ * Date fields and
+ * Date parameters are valid.
* =, +=, etc. and pre- and post-increment
- * and -decrement are not supported. Therefore, there are no side
- * effects from evaluation of any expressions.
+ * =, +=, etc. and
+ * pre- and post-increment and -decrement are not supported. Therefore, there
+ * are no side effects from evaluation of any expressions.
* Collection.contains(Object o), Collection.isEmpty(),
* String.startsWith(String s), and String.endsWith(String e).
@@ -171,14 +172,14 @@
* returned false for the evaluation of the current set of variable
* values. Other values for variables might still qualify the candidate
* instance for inclusion in the result set.
- * Collection types) is
- * specified using a variable declaration and the
+ * Collection types)
+ * is specified using a variable declaration and the
* Collection.contains(Object o) method.
* Identifiers in the expression are considered to be in the name
* space of the specified class, with the addition of declared imports,
- * parameters and variables. As in the Java language, this is a reserved
- * word which means the element of the collection being evaluated.
+ * parameters and variables. As in the Java language, this is a
+ * reserved word which means the element of the collection being evaluated.
*
Navigation through single-valued fields is specified by the Java
* language syntax of field_name.field_name....field_name.
*
A JDO implementation is allowed to reorder the filter expression
@@ -187,26 +188,26 @@
*/
void setFilter(String filter);
- /** Set the import statements to be used to identify the fully qualified name of
- * variables or parameters. Parameters and unbound variables might
+ /** Set the import statements to be used to identify the fully qualified name
+ * of variables or parameters. Parameters and unbound variables might
* come from a different class from the candidate class, and the names
* need to be declared in an import statement to eliminate ambiguity.
* Import statements are specified as a String with semicolon-separated
* statements.
- *
The String parameter to this method follows the syntax of the
- * import statement of the Java language.
+ *
The String parameter to this method follows the syntax of
+ * the import statement of the Java language.
* @param imports import statements separated by semicolons.
*/
void declareImports(String imports);
/** Declare the list of parameters query execution.
*
- * The parameter declaration is a String containing one or more query
- * parameter declarations separated with commas. Each parameter named
+ * The parameter declaration is a String containing one or more
+ * query parameter declarations separated with commas. Each parameter named
* in the parameter declaration must be bound to a value when
* the query is executed.
- *
The String parameter to this method follows the syntax for formal
- * parameters in the Java language.
+ *
The String parameter to this method follows the syntax for
+ * formal parameters in the Java language.
* @param parameters the list of parameters separated by commas.
*/
void declareParameters(String parameters);
@@ -221,9 +222,9 @@
*/
void declareVariables(String variables);
- /** Set the ordering specification for the result Collection. The
- * ordering specification is a String containing one or more ordering
- * declarations separated by commas.
+ /** Set the ordering specification for the result Collection.
+ * The ordering specification is a String containing one or more
+ * ordering declarations separated by commas.
*
*
Each ordering declaration is the name of the field on which * to order the results followed by one of the following words: @@ -232,9 +233,9 @@ *
The field must be declared in the candidate class or must be * a navigation expression starting with a field in the candidate class. * - *
Valid field types are primitive types except boolean; wrapper types
- * except Boolean; BigDecimal; BigInteger;
- * String; and Date.
+ *
Valid field types are primitive types except boolean;
+ * wrapper types except Boolean; BigDecimal;
+ * BigInteger; String; and Date.
* @param ordering the ordering specification.
*/
void setOrdering(String ordering);
@@ -293,12 +294,13 @@
*/
Object execute(Object p1, Object p2, Object p3);
- /** Execute the query and return the filtered Collection. The query
- * is executed with the parameters set by the Map values. Each Map entry
- * consists of a key which is the name of the parameter in the
- * declareParameters method, and a value which is the value used in
- * the execute method. The keys in the Map and the declared parameters
- * must exactly match or a JDOUserException is thrown.
+ /** Execute the query and return the filtered Collection. The
+ * query is executed with the parameters set by the Map values.
+ * Each Map entry consists of a key which is the name of the
+ * parameter in the declareParameters method, and a value which
+ * is the value used in the execute method. The keys in the
+ * Map and the declared parameters must exactly match or a
+ * JDOUserException is thrown.
* @return the filtered Collection.
* @see #executeWithArray(Object[] parameters)
* @param parameters the Map containing all of the parameters.
@@ -317,11 +319,11 @@
*
The filter, import, declared parameters, declared variables, and * ordering statements are verified for consistency. * - *
Each element in the candidate Collection is examined to see that it
- * is assignment compatible to the Class of the query. It is then evaluated
- * by the Boolean expression of the filter. The element passes the filter
- * if there exist unique values for all variables for which the filter
- * expression evaluates to true.
+ *
Each element in the candidate Collection is examined to
+ * see that it is assignment compatible to the Class of the
+ * query. It is then evaluated by the Boolean expression of the filter.
+ * The element passes the filter if there exist unique values for all
+ * variables for which the filter expression evaluates to true.
* @return the filtered Collection.
* @param parameters the Object array with all of the parameters.
*/
@@ -336,18 +338,20 @@
PersistenceManager getPersistenceManager();
/** Close a query result and release any resources associated with it. The
- * parameter is the return from execute(...) and might have iterators open on it.
- * Iterators associated with the query result are invalidated: they return false
- * to hasNext() and throw NoSuchElementException to next().
- * @param queryResult the result of execute(...) on this Query instance.
+ * parameter is the return from execute(...) and might have
+ * iterators open on it. Iterators associated with the query result are
+ * invalidated: they return false to hasNext()
+ * and throw NoSuchElementException to next().
+ * @param queryResult the result of execute(...) on this
+ * Query instance.
*/
void close (Object queryResult);
- /** Close all query results associated with this Query instance, and release all
- * resources associated with them. The query results might have iterators open
- * on them. Iterators associated with the query results are invalidated:
- * they return false to hasNext() and throw
- * NoSuchElementException to next().
+ /** Close all query results associated with this Query instance,
+ * and release all resources associated with them. The query results might
+ * have iterators open on them. Iterators associated with the query results
+ * are invalidated: they return false to hasNext()
+ * and throw NoSuchElementException to next().
*/
void closeAll ();
Index: src/java/javax/jdo/datastore/Sequence.java
===================================================================
--- src/java/javax/jdo/datastore/Sequence.java (Revision 389512)
+++ src/java/javax/jdo/datastore/Sequence.java (Arbeitskopie)
@@ -79,4 +79,4 @@
* @return the current value
*/
long currentValue();
-}
\ No newline at end of file
+}
Index: src/java/javax/jdo/datastore/JDOConnection.java
===================================================================
--- src/java/javax/jdo/datastore/JDOConnection.java (Revision 389512)
+++ src/java/javax/jdo/datastore/JDOConnection.java (Arbeitskopie)
@@ -21,11 +21,9 @@
package javax.jdo.datastore;
-import javax.jdo.PersistenceManager;
-
/**
* The underlying connection that is being used by a
- * {@link PersistenceManager}.
+ * {@link javax.jdo.PersistenceManager}.
* @version 2.0
* @since 2.0
*/
Index: src/java/javax/jdo/PersistenceManagerFactory.java
===================================================================
--- src/java/javax/jdo/PersistenceManagerFactory.java (Revision 389512)
+++ src/java/javax/jdo/PersistenceManagerFactory.java (Arbeitskopie)
@@ -29,9 +29,9 @@
import javax.jdo.listener.InstanceLifecycleListener;
/** The PersistenceManagerFactory is the interface to use to obtain
- * PersistenceManager instances. All PersistenceManager instances obtained
- * from the same PersistenceManagerFactory will have the same default
- * properties.
+ * PersistenceManager instances. All PersistenceManager
+ * instances obtained from the same PersistenceManagerFactory will
+ * have the same default properties.
*
*
PersistenceManagerFactory instances may be configured and
* serialized for later use. They may be stored via JNDI and looked up
@@ -39,12 +39,13 @@
*
*
Once the first PersistenceManager is obtained from the
* PersistenceManagerFactory, the factory can no longer be configured.
- *
If the ConnectionFactory property is set (non-null) then
- * all other Connection properties including ConnectionFactoryName are ignored;
- * otherwise, if ConnectionFactoryName is set (non-null) then
- * all other Connection properties are ignored.
- * Similarly, if the ConnectionFactory2 property is set (non-null) then
- * ConnectionFactory2Name is ignored.
+ *
If the ConnectionFactory property is set (non-null)
+ * then all other Connection properties including ConnectionFactoryName
+ * are ignored;
+ * otherwise, if ConnectionFactoryName is set (non-null)
+ * then all other Connection properties are ignored.
+ * Similarly, if the ConnectionFactory2 property is set
+ * (non-null) then ConnectionFactory2Name is ignored.
*
Operational state (PersistenceManager pooling, connection pooling,
* operational parameters) must not be serialized.
*
@@ -81,22 +82,23 @@
*/
boolean isClosed();
- /** Get an instance of PersistenceManager from this factory. The instance has
- * default values for options.
+ /** Get an instance of PersistenceManager from this factory.
+ * The instance has default values for options.
*
- *
After the first use of getPersistenceManager, no "set" methods will
- * succeed.
+ *
After the first use of getPersistenceManager, no "set"
+ * methods will succeed.
*
* @return a PersistenceManager instance with default options.
*/
PersistenceManager getPersistenceManager();
- /** Get an instance of PersistenceManager from this factory. The instance has
- * default values for options. The parameters userid and password are used
+ /** Get an instance of PersistenceManager from this factory.
+ * The instance has default values for options.
+ * The parameters userid and password are used
* when obtaining datastore connections from the connection pool.
*
- *
After the first use of getPersistenceManager, no "set" methods will
- * succeed.
+ *
After the first use of getPersistenceManager, no "set"
+ * methods will succeed.
*
* @return a PersistenceManager instance with default options.
* @param userid the userid for the connection
@@ -120,9 +122,9 @@
void setConnectionPassword (String password);
/** Set the URL for the data store connection.
- * @param URL the URL for the data store connection.
+ * @param url the URL for the data store connection.
*/
- void setConnectionURL (String URL);
+ void setConnectionURL (String url);
/** Get the URL for the data store connection.
* @return the URL for the data store connection.
@@ -191,15 +193,15 @@
*/
Object getConnectionFactory2 ();
- /** Set the default Multithreaded setting for all PersistenceManager instances
- * obtained from this factory.
+ /** Set the default Multithreaded setting for all PersistenceManager
+ * instances obtained from this factory.
*
* @param flag the default Multithreaded setting.
*/
void setMultithreaded (boolean flag);
- /** Get the default Multithreaded setting for all PersistenceManager instances
- * obtained from this factory.
+ /** Get the default Multithreaded setting for all PersistenceManager
+ * instances obtained from this factory.
*
* @return the default Multithreaded setting.
*/
@@ -219,29 +221,29 @@
*/
String getMapping ();
- /** Set the default Optimistic setting for all PersistenceManager instances
- * obtained from this factory.
+ /** Set the default Optimistic setting for all PersistenceManager
+ * instances obtained from this factory.
*
* @param flag the default Optimistic setting.
*/
void setOptimistic (boolean flag);
- /** Get the default Optimistic setting for all PersistenceManager instances
- * obtained from this factory.
+ /** Get the default Optimistic setting for all PersistenceManager
+ * instances obtained from this factory.
*
* @return the default Optimistic setting.
*/
boolean getOptimistic();
- /** Set the default RetainValues setting for all PersistenceManager instances
- * obtained from this factory.
+ /** Set the default RetainValues setting for all PersistenceManager
+ * instances obtained from this factory.
*
* @param flag the default RetainValues setting.
*/
void setRetainValues (boolean flag);
- /** Get the default RetainValues setting for all PersistenceManager instances
- * obtained from this factory.
+ /** Get the default RetainValues setting for all PersistenceManager
+ * instances obtained from this factory.
*
* @return the default RetainValues setting.
*/
@@ -269,43 +271,43 @@
*/
boolean getRestoreValues();
- /** Set the default NontransactionalRead setting for all PersistenceManager instances
- * obtained from this factory.
+ /** Set the default NontransactionalRead setting for all PersistenceManager
+ * instances obtained from this factory.
*
* @param flag the default NontransactionalRead setting.
*/
void setNontransactionalRead (boolean flag);
- /** Get the default NontransactionalRead setting for all PersistenceManager instances
- * obtained from this factory.
+ /** Get the default NontransactionalRead setting for all PersistenceManager
+ * instances obtained from this factory.
*
* @return the default NontransactionalRead setting.
*/
boolean getNontransactionalRead ();
- /** Set the default NontransactionalWrite setting for all PersistenceManager instances
- * obtained from this factory.
+ /** Set the default NontransactionalWrite setting for all PersistenceManager
+ * instances obtained from this factory.
*
* @param flag the default NontransactionalWrite setting.
*/
void setNontransactionalWrite (boolean flag);
- /** Get the default NontransactionalWrite setting for all PersistenceManager instances
- * obtained from this factory.
+ /** Get the default NontransactionalWrite setting for all PersistenceManager
+ * instances obtained from this factory.
*
* @return the default NontransactionalWrite setting.
*/
boolean getNontransactionalWrite ();
- /** Set the default IgnoreCache setting for all PersistenceManager instances
- * obtained from this factory.
+ /** Set the default IgnoreCache setting for all PersistenceManager
+ * instances obtained from this factory.
*
* @param flag the default IgnoreCache setting.
*/
void setIgnoreCache (boolean flag);
- /** Get the default IgnoreCache setting for all PersistenceManager instances
- * obtained from this factory.
+ /** Get the default IgnoreCache setting for all PersistenceManager
+ * instances obtained from this factory.
*
* @return the default IngoreCache setting.
*/
@@ -327,8 +329,8 @@
void setDetachAllOnCommit(boolean flag);
/** Return non-configurable properties of this PersistenceManagerFactory.
- * Properties with keys VendorName and VersionNumber are required. Other
- * keys are optional.
+ * Properties with keys VendorName and VersionNumber
+ * are required. Other keys are optional.
* @return the non-configurable properties of this
* PersistenceManagerFactory.
*/
@@ -369,7 +371,8 @@
*
*
The standard JDO query language is represented by a String:
*
javax.jdo.query.JDOQL
- * @return the Collection of Strings representing the supported options.
+ * @return the Collection of Strings representing
+ * the supported options.
*/
Collection supportedOptions();
Index: src/java/javax/jdo/identity/ObjectIdentity.java
===================================================================
--- src/java/javax/jdo/identity/ObjectIdentity.java (Revision 389512)
+++ src/java/javax/jdo/identity/ObjectIdentity.java (Arbeitskopie)
@@ -53,7 +53,7 @@
/** The delimiter for String constructor.
*/
- private static String STRING_DELIMITER = ":"; //NOI18N
+ private static final String STRING_DELIMITER = ":"; //NOI18N
/** Constructor with class and key.
* @param pcClass the class
Index: src/java/javax/jdo/identity/StringIdentity.java
===================================================================
--- src/java/javax/jdo/identity/StringIdentity.java (Revision 389512)
+++ src/java/javax/jdo/identity/StringIdentity.java (Arbeitskopie)
@@ -25,8 +25,6 @@
import java.io.ObjectInput;
import java.io.ObjectOutput;
-import javax.jdo.JDOUserException;
-
/** This class is for identity with a single String field.
* @version 2.0
*/
Index: src/java/javax/jdo/spi/I18NHelper.java
===================================================================
--- src/java/javax/jdo/spi/I18NHelper.java (Revision 389512)
+++ src/java/javax/jdo/spi/I18NHelper.java (Arbeitskopie)
@@ -39,7 +39,8 @@
* Subsequently, instance methods can be used to format message strings
* using the text from the bundle, as in
*
- * Each managed Each managed
* @see PersistenceCapable#jdoMakeDirty(String fieldName)
* @param pc the calling Transient nontransactional instances return
@@ -109,7 +111,8 @@
/** Tests whether this object has been deleted.
*
- * Instances that have been deleted in the current transaction return Transient instances return
Index: src/java/javax/jdo/spi/PersistenceCapable.java
===================================================================
--- src/java/javax/jdo/spi/PersistenceCapable.java (Revision 389512)
+++ src/java/javax/jdo/spi/PersistenceCapable.java (Arbeitskopie)
@@ -17,7 +17,6 @@
package javax.jdo.spi;
import javax.jdo.PersistenceManager;
-import javax.jdo.JDOHelper; // for javadoc
/**
* A class that can be managed by a binary-compatible JDO implementation
@@ -241,8 +240,8 @@
*
* Transient instances return false.
*
- * @see JDOHelper#isDirty(Object pc)
- * @see JDOHelper#makeDirty(Object pc, String fieldName)
+ * @see javax.jdo.JDOHelper#isDirty(Object pc)
+ * @see javax.jdo.JDOHelper#makeDirty(Object pc, String fieldName)
* @see #jdoMakeDirty(String fieldName)
* @return true if this instance has been modified in the current transaction.
*/
@@ -255,7 +254,7 @@
*
* Transient instances return false.
*
- * @see JDOHelper#isTransactional(Object pc)
+ * @see javax.jdo.JDOHelper#isTransactional(Object pc)
* @see PersistenceManager#makeTransactional(Object pc)
* @return true if this instance is transactional.
*/
@@ -264,7 +263,7 @@
/** Tests whether this object is persistent.
* Instances that represent persistent objects in the data store
* return true.
- * @see JDOHelper#isPersistent(Object pc)
+ * @see javax.jdo.JDOHelper#isPersistent(Object pc)
* @see PersistenceManager#makePersistent(Object pc)
* @return true if this instance is persistent.
*/
@@ -277,7 +276,7 @@
*
* Transient instances return false.
*
- * @see JDOHelper#isNew(Object pc)
+ * @see javax.jdo.JDOHelper#isNew(Object pc)
* @see PersistenceManager#makePersistent(Object pc)
* @return true if this instance was made persistent
* in the current transaction.
@@ -290,7 +289,7 @@
*
* Transient instances return false.
*
- * @see JDOHelper#isDeleted(Object pc)
+ * @see javax.jdo.JDOHelper#isDeleted(Object pc)
* @see PersistenceManager#deletePersistent(Object pc)
* @return true if this instance was deleted
* in the current transaction.
@@ -303,7 +302,7 @@
*
* Transient instances return false.
*
- * @see JDOHelper#isDetached(Object pc)
+ * @see javax.jdo.JDOHelper#isDetached(Object pc)
* @return true if this instance is detached.
* @since 2.0
*/
Index: src/java/javax/jdo/spi/JDOImplHelper.java
===================================================================
--- src/java/javax/jdo/spi/JDOImplHelper.java (Revision 389512)
+++ src/java/javax/jdo/spi/JDOImplHelper.java (Arbeitskopie)
@@ -44,13 +44,12 @@
import javax.jdo.JDOFatalInternalException;
import javax.jdo.JDOFatalUserException;
import javax.jdo.JDOUserException;
-import javax.jdo.spi.JDOPermission;
/** This class is a helper class for JDO implementations. It contains methods
* to register metadata for persistence-capable classes and to perform common
* operations needed by implementations, not by end users.
- * Persistence-capable classes register themselves via a static method
* at class load time.
* There is no security restriction on this access. JDO implementations
@@ -115,7 +114,8 @@
* checks that the caller is authorized for For example, an ObjectId class that has three key fields ( Persistent instances of Persistent instances of Transient instances and instances of classes
* that do not implement The ObjectId may be serialized
- * and later restored, and used with a If the JDO identity is managed by the application, then the ObjectId may
- * be used with a If the JDO identity is not managed by the application or the data store,
* then the ObjectId returned is only valid within the current transaction.
@@ -251,7 +250,8 @@
* @see PersistenceCapable#jdoGetObjectId()
* @see PersistenceManager#getObjectById(Object oid, boolean validate)
* @param pc the PersistenceCapable instance.
- * @return a copy of the ObjectId of the parameter instance as of the beginning of the transaction.
+ * @return a copy of the ObjectId of the parameter instance as of the
+ * beginning of the transaction.
*/
public static Object getObjectId(Object pc) {
if (pc instanceof PersistenceCapable) {
@@ -306,7 +306,8 @@
* @see PersistenceCapable#jdoGetTransactionalObjectId()
* @see PersistenceManager#getObjectById(Object oid, boolean validate)
* @param pc the Transient instances and instances of classes
* that do not implement
- * @see StateManager#makeDirty(PersistenceCapable pc, String fieldName)
+ * @see javax.jdo.spi.StateManager#makeDirty(PersistenceCapable pc, String fieldName)
* @see PersistenceCapable#jdoIsDirty()
* @param pc the A Closing a Closing a All of the settings of the other All of the settings of the other Note that the If the If the If the If the If there is not an instance already in the cache with the same JDO
- * identity as the If there is a transaction in progress, the returned instance will
@@ -272,10 +277,10 @@
* choice of the implementation.
* It is an implementation decision whether to access the data store,
* if required to determine the exact class. This will be the case of
- * inheritance, where multiple If the validate flag is If the validate flag is If the If there is an instance already in the cache with the same JDO
- * identity as the If the If there is an instance already in the cache with the same JDO identity
+ * as the If there is not an instance already in the cache with the same JDO
- * identity as the If there is a data store transaction in progress, the returned
@@ -305,7 +310,8 @@
* instance will be persistent-nontransactional.
* @see #getObjectId(Object pc)
* @see #getTransactionalObjectId(Object pc)
- * @return the The The If the object identity is being changed in the transaction, by the
* application modifying one or more of the application key fields,
@@ -353,8 +359,8 @@
* change to the ObjectId instance returned by this method, there is
* no effect on the instance from which the ObjectId was obtained.
* The The instance loses its JDO identity and it is no longer associated
- * with any The instances lose their JDO identity and they are no longer associated
- * with any The instances lose their JDO identity and they are no longer associated
- * with any For persistent instances read in optimistic transactions, this method
* allows the application to make the state of the instance part of the
* transactional state. At transaction commit, the state of the instance in
- * the cache is compared to the state of the instance in the data store. If they
- * are not the same, then an exception is thrown.
+ * the cache is compared to the state of the instance in the data store. If
+ * they are not the same, then an exception is thrown.
* @param pc the instance to make transactional.
*/
void makeTransactional (Object pc);
@@ -659,7 +668,8 @@
*/
void makeTransactionalAll (Object[] pcs);
- /** Make a The The The If the useFetchPlan parameter is false, this method behaves exactly
+ * as the corresponding method without the useFetchPlan parameter.
+ * If the useFetchPlan parameter is true, and the fetch plan has not been
+ * modified from its default setting, all fields in the current fetch plan
+ * are fetched, and other fields might be fetched lazily by the
+ * implementation. If the useFetchPlan parameter is true, and the fetch
+ * plan has been changed from its default setting, then the fields
+ * specified by the fetch plan are loaded, along with related instances
+ * specified by the fetch plan.
* @param pc the instance
- * @param FGOnly whether to only retrieve the fields in the current fetch group
+ * @param useFetchPlan whether to use the current fetch plan to determine
+ * which fields to load and which instances to retrieve.
* @since 2.0
*/
- void retrieve (Object pc, boolean FGOnly);
+ void retrieve (Object pc, boolean useFetchPlan);
/** Retrieve field values of instances from the store. This tells
- * the The The The If the useFetchPlan parameter is false, this method behaves exactly
+ * as the corresponding method without the useFetchPlan parameter.
+ * If the useFetchPlan parameter is true, and the fetch plan has not been
+ * modified from its default setting, all fields in the current fetch plan
+ * are fetched, and other fields might be fetched lazily by the
+ * implementation. If the useFetchPlan parameter is true, and the fetch
+ * plan has been changed from its default setting, then the fields
+ * specified by the fetch plan are loaded, along with related instances
+ * specified by the fetch plan.
* @param pcs the instances
- * @param FGOnly whether to retrieve only the fields in the current fetch group
+ * @param useFetchPlan whether to use the current fetch plan to determine
+ * which fields to load and which instances to retrieve.
* @since 1.0.1
*/
- void retrieveAll (Collection pcs, boolean FGOnly);
+ void retrieveAll (Collection pcs, boolean useFetchPlan);
/** Retrieve field values of instances from the store. This tells
- * the The The The If the useFetchPlan parameter is false, this method behaves exactly
+ * as the corresponding method without the useFetchPlan parameter.
+ * If the useFetchPlan parameter is true, and the fetch plan has not been
+ * modified from its default setting, all fields in the current fetch plan
+ * are fetched, and other fields might be fetched lazily by the
+ * implementation. If the useFetchPlan parameter is true, and the fetch
+ * plan has been changed from its default setting, then the fields
+ * specified by the fetch plan are loaded, along with related instances
+ * specified by the fetch plan.
* @param pcs the instances
- * @param FGOnly whether to retrieve only the fields in the current fetch group
+ * @param useFetchPlan whether to use the current fetch plan to determine
+ * which fields to load and which instances to retrieve.
* @since 1.0.1
*/
- void retrieveAll (Object[] pcs, boolean FGOnly);
+ void retrieveAll (Object[] pcs, boolean useFetchPlan);
/** The application can manage the In order for the application to construct an instance of the ObjectId class
- * it needs to know the class being used by the JDO implementation.
+ * In order for the application to construct an instance of the ObjectId
+ * class it needs to know the class being used by the JDO implementation.
* @param cls the IgnoreCache set to IgnoreCache set to IgnoreCache set to IgnoreCache set to The Only one Only one throw new JDOFatalInternalException (msg.msg("ERR_NoMetadata", cls.getName()));
+ * throw new JDOFatalInternalException (msg.msg("ERR_NoMetadata",
+ * cls.getName()));
* @since 1.0.1
* @version 1.1
*/
@@ -291,7 +292,8 @@
* @param msgArgs an array of arguments to substitute into the message
* @return the resolved message text
*/
- final private static String getMessage(ResourceBundle messages, String messageKey, Object msgArgs[])
+ final private static String getMessage(ResourceBundle messages,
+ String messageKey, Object[] msgArgs)
{
for (int i=0; iJDOPermission class is for operations that are reserved for
+ * JDO implementations and should not be called by other code. A
* JDOPermission is a named permission and has no
* actions. There are two names currently defined. Each named permission
* has a corresponding public static final field which contains an instance
@@ -38,8 +38,8 @@
*
*
* setStateManagerThis allows setting the StateManager for an instance of PersistenceCapable.
- * The StateManager
+ * This allows setting the
* StateManager for an instance of
+ * PersistenceCapable. The StateManager
* has unlimited access to get and set persistent and transactional fields of
* the PersistenceCapable instance.This is dangerous in that information (possibly confidential)
@@ -48,16 +48,16 @@
*
*
*
*
* getMetadataThis allows getting metadata for any
+ * PersistenceCapable class that has
- * registered with JDOImplHelper.This allows getting metadata for any
* PersistenceCapable
+ * class that has registered with JDOImplHelper.This is dangerous in that metadata information (possibly confidential)
* normally unavailable would be accessible to malicious code.
*
*
Index: src/java/javax/jdo/spi/StateInterrogation.java
===================================================================
--- src/java/javax/jdo/spi/StateInterrogation.java (Revision 389512)
+++ src/java/javax/jdo/spi/StateInterrogation.java (Arbeitskopie)
@@ -174,7 +174,7 @@
* @return the manageMetadataThis allows managing metadata for any
+ * PersistenceCapable class that has
- * registered with JDOImplHelper.This allows managing metadata for any
* PersistenceCapable
+ * class that has registered with JDOImplHelper.This is dangerous in that metadata information (possibly confidential)
* normally unavailable would be manageable (modifiable) by malicious code.
* PersistenceManager associated with the
* parameter instance.
*/
- PersistenceManager getPersistenceManager (Object pc);
+ PersistenceManager getPersistenceManager (Object pc);
/** Return a copy of the JDO identity associated with the parameter
* instance.
@@ -208,7 +208,7 @@
* @return a copy of the ObjectId of the parameter instance as of the
* beginning of the transaction.
*/
- Object getObjectId (Object pc);
+ Object getObjectId (Object pc);
/** Return a copy of the JDO identity associated with the parameter
* instance.
@@ -220,7 +220,7 @@
* @return a copy of the ObjectId of the parameter instance as modified
* in this transaction.
*/
- Object getTransactionalObjectId (Object pc);
+ Object getTransactionalObjectId (Object pc);
/** Return the version of the parameter instance.
*
@@ -230,7 +230,7 @@
* @return a copy of the ObjectId of the parameter instance as modified
* in this transaction.
*/
- Object getVersion (Object pc);
+ Object getVersion (Object pc);
/** Explicitly mark the parameter instance and field dirty.
* Normally, PersistenceCapable classes are able to detect
@@ -245,6 +245,6 @@
* @param pc the instance.
* @param fieldName the name of the field to be marked dirty.
*/
- boolean makeDirty (Object pc, String fieldName);
+ boolean makeDirty (Object pc, String fieldName);
-}
\ No newline at end of file
+}
Index: src/java/javax/jdo/spi/StateManager.java
===================================================================
--- src/java/javax/jdo/spi/StateManager.java (Revision 389512)
+++ src/java/javax/jdo/spi/StateManager.java (Arbeitskopie)
@@ -16,17 +16,16 @@
package javax.jdo.spi;
-import java.util.BitSet;
-
import javax.jdo.PersistenceManager;
/** This interface is the point of contact between managed instances of
* PersistenceCapable classes and the JDO implementation. It contains
- * the methods used by PersistenceCapable instances to delegate behavior to
- * the JDO implementation.
- *PersistenceCapable instance contains a reference to a
- * StateManager. A StateManager might manage one or multiple instances of
- * PersistenceCapable instances, at the choice of the implementation.
+ * the methods used by PersistenceCapable instances to delegate
+ * behavior to the JDO implementation.
+ *PersistenceCapable instance contains a reference
+ * to a StateManager. A StateManager might manage one
+ * or multiple instances of PersistenceCapable instances, at the
+ * choice of the implementation.
*
* @version 2.0
*
@@ -36,7 +35,8 @@
/** The owning StateManager uses this method to supply the
* value of the flags to the PersistenceCapable instance.
* @param pc the calling PersistenceCapable instance
- * @return the value of jdoFlags to be stored in the PersistenceCapable instance
+ * @return the value of jdoFlags to be stored in the
+ * PersistenceCapable instance
*/
byte replacingFlags(PersistenceCapable pc);
@@ -62,17 +62,19 @@
*PersistenceCapable instance
- * @return true if this instance has been modified in the current transaction.
+ * @return true if this instance has been modified in the
+ * current transaction.
*/
boolean isDirty(PersistenceCapable pc);
/** Tests whether this object is transactional.
*
- * Instances that respect transaction boundaries return true. These instances
- * include transient instances made transactional as a result of being the
- * target of a makeTransactional method call; newly made persistent or deleted
- * persistent instances; persistent instances read in data store
- * transactions; and persistent instances modified in optimistic transactions.
+ * Instances that respect transaction boundaries return true.
+ * These instances include transient instances made transactional as a result
+ * of being the target of a makeTransactional method call;
+ * newly made persistent or deleted persistent instances; persistent instances
+ * read in data store transactions; and persistent instances modified in
+ * optimistic transactions.
*
*false.
*true.
+ * Instances that have been deleted in the current transaction return
+ * true.
*
*false.
*JDOImplHelper allows construction of instances of persistence-capable
- * classes without using reflection.
+ * JDOImplHelper allows construction of instances of
+ * persistence-capable classes without using reflection.
* JDOPermission("getMetadata"),
* and if not, throws SecurityException.
* @return an instance of JDOImplHelper.
- * @throws SecurityException if the caller is not authorized for JDOPermission("getMetadata").
+ * @throws SecurityException if the caller is not authorized for
+ * JDOPermission("getMetadata").
*/
public static JDOImplHelper getInstance()
throws SecurityException {
@@ -158,7 +158,8 @@
return meta.getFieldFlags();
}
- /** Get the persistence-capable superclass for a PersistenceCapable class.
+ /** Get the persistence-capable superclass for a PersistenceCapable
+ * class.
* @param pcClass the PersistenceCapable class.
* @return The PersistenceCapable superclass for this class,
* or null if there isn't one.
@@ -182,8 +183,8 @@
return pcInstance == null?null:pcInstance.jdoNewInstance(sm);
}
- /** Create a new instance of the class and assign its jdoStateManager and
- * key values from the ObjectId. If the oid parameter is null,
+ /** Create a new instance of the class and assign its jdoStateManager
+ * and key values from the ObjectId. If the oid parameter is null,
* no key values are copied.
* The new instance has its jdoFlags set to LOAD_REQUIRED.
* @see PersistenceCapable#jdoNewInstance(StateManager sm, Object oid)
@@ -252,7 +253,8 @@
* This method is generated in the PersistenceCapable class to
* generate a call to the field manager for each key field in the ObjectId.
* int id,
- * String name, and Float salary) would have the method generated:
+ * String name, and Float salary) would have the
+ * method generated:
*
* void jdoCopyKeyFieldsToObjectId (Object oid, ObjectIdFieldSupplier fm) {
*
oid.id = fm.fetchIntField (0);
@@ -277,10 +279,11 @@
}
/** Copy fields to an outside source from the key fields in the ObjectId.
- * This method is generated in the PersistenceCapable class to generate
- * a call to the field manager for each key field in the ObjectId. For
- * example, an ObjectId class that has three key fields (int id,
- * String name, and Float salary) would have the method generated:
+ * This method is generated in the PersistenceCapable class to
+ * generate a call to the field manager for each key field in the ObjectId.
+ * For example, an ObjectId class that has three key fields (int id,
+ * String name, and Float salary) would have the
+ * method generated:
* void jdoCopyKeyFieldsFromObjectId
*
(PersistenceCapable oid, ObjectIdFieldConsumer fm) {
*
fm.storeIntField (0, oid.id);
@@ -311,11 +314,13 @@
*
* @param pcClass the PersistenceCapable class
* used as the key for lookup.
- * @param fieldNames an array of String field names for persistent and transactional fields
+ * @param fieldNames an array of String field names for
+ * persistent and transactional fields
* @param fieldTypes an array of Class field types
* @param fieldFlags the Field Flags for persistent and transactional fields
* @param pc an instance of the PersistenceCapable class
- * @param persistenceCapableSuperclass the most immediate superclass that is PersistenceCapable
+ * @param persistenceCapableSuperclass the most immediate superclass that is
+ * PersistenceCapable
*/
public static void registerClass (Class pcClass,
String[] fieldNames, Class[] fieldTypes,
@@ -462,7 +467,8 @@
* the corresponding checkAuthorizedStateManager and the class of the
* instance of the parameter must have been registered.
* @param smClass a Class that is authorized for JDOPermission("setStateManager").
- * @throws SecurityException if the caller is not authorized for JDOPermission("setStateManager").
+ * @throws SecurityException if the caller is not authorized for
+ * JDOPermission("setStateManager").
* @since 1.0.1
*/
public static void registerAuthorizedStateManagerClass (Class smClass)
@@ -483,8 +489,10 @@
* During replaceStateManager, a persistence-capable class will call
* the corresponding checkAuthorizedStateManager and the class of the
* instance of the parameter must have been registered.
- * @param smClasses a Collection of Classes that are authorized for JDOPermission("setStateManager").
- * @throws SecurityException if the caller is not authorized for JDOPermission("setStateManager").
+ * @param smClasses a Collection of Classes that are authorized for
+ * JDOPermission("setStateManager").
+ * @throws SecurityException if the caller is not authorized for
+ * JDOPermission("setStateManager").
* @since 1.0.1
*/
public static void registerAuthorizedStateManagerClasses (Collection smClasses)
@@ -735,7 +743,8 @@
* @param fieldNames An array of String
* @param fieldTypes An array of Class
* @param fieldFlags an array of int
- * @param persistenceCapableSuperclass the most immediate PersistenceCapable superclass
+ * @param persistenceCapableSuperclass the most immediate
+ * PersistenceCapable superclass
* @param pc An instance of the PersistenceCapable class
*/
Meta (String[] fieldNames, Class[] fieldTypes, byte[] fieldFlags,
@@ -751,7 +760,7 @@
* for the Model at runtime. The field
* is passed by the static class initialization.
*/
- String fieldNames[];
+ String[] fieldNames;
/** Get the field names from the metadata.
* @return the array of field names.
@@ -764,7 +773,7 @@
* for the Model at runtime. The field
* is passed by the static class initialization.
*/
- Class fieldTypes[];
+ Class[] fieldTypes;
/** Get the field types from the metadata.
* @return the array of field types.
@@ -777,7 +786,7 @@
* for the Model at runtime. The field
* is passed by the static class initialization.
*/
- byte fieldFlags[];
+ byte[] fieldFlags;
/** Get the field types from the metadata.
* @return the array of field types.
@@ -786,7 +795,8 @@
return fieldFlags;
}
- /** This is the Class instance of the PersistenceCapable superclass.
+ /** This is the Class instance of the
+ * PersistenceCapable superclass.
*/
Class persistenceCapableSuperclass;
Index: src/java/javax/jdo/JDOHelper.java
===================================================================
--- src/java/javax/jdo/JDOHelper.java (Revision 389512)
+++ src/java/javax/jdo/JDOHelper.java (Arbeitskopie)
@@ -45,7 +45,6 @@
import javax.jdo.spi.JDOImplHelper.StateInterrogationObjectReturn;
import javax.jdo.spi.PersistenceCapable;
import javax.jdo.spi.StateInterrogation;
-import javax.jdo.spi.StateManager; // for javadoc
import javax.naming.Context;
import javax.naming.InitialContext;
@@ -228,21 +227,21 @@
/** Return a copy of the JDO identity associated with the parameter instance.
*
- * PersistenceCapable classes have a JDO identity
- * managed by the PersistenceManager. This method returns a copy of the
- * ObjectId that represents the JDO identity.
+ * PersistenceCapable classes have a
+ * JDO identity managed by the PersistenceManager. This method
+ * returns a copy of the ObjectId that represents the JDO identity.
*
* PersistenceCapable return null.
*
* PersistenceManager from the same JDO
- * implementation to locate a persistent instance with the same data store
- * identity.
+ * and later restored, and used with a PersistenceManager from
+ * the same JDO implementation to locate a persistent instance with the same
+ * data store identity.
*
* PersistenceManager from any JDO implementation that supports
- * the PersistenceCapable class.
+ * be used with a PersistenceManager from any JDO implementation
+ * that supports the PersistenceCapable class.
*
* PersistenceCapable instance.
- * @return a copy of the ObjectId of the parameter instance as modified in this transaction.
+ * @return a copy of the ObjectId of the parameter instance as modified in
+ * this transaction.
*/
public static Object getTransactionalObjectId(Object pc) {
if (pc instanceof PersistenceCapable) {
@@ -337,10 +338,11 @@
*PersistenceCapable return false.
*PersistenceCapable instance.
- * @return true if the parameter instance has been modified in the current transaction.
+ * @return true if the parameter instance has been modified in
+ * the current transaction.
*/
public static boolean isDirty(Object pc) {
if (pc instanceof PersistenceCapable) {
@@ -453,11 +455,12 @@
}
}
- /** Get a PersistenceManagerFactory based on a Properties instance, using
- * the current thread's context class loader to locate the
+ /** Get a PersistenceManagerFactory based on a Properties
+ * instance, using the current thread's context class loader to locate the
* PersistenceManagerFactory class.
* @return the PersistenceManagerFactory.
- * @param props a Properties instance with properties of the PersistenceManagerFactory.
+ * @param props a Properties instance with properties of the
+ * PersistenceManagerFactory.
* @see #getPersistenceManagerFactory(Map,ClassLoader)
*/
public static PersistenceManagerFactory getPersistenceManagerFactory
@@ -499,8 +502,10 @@
* instance. In this case, the properties of the returned
* instance must exactly match the requested properties.
* @return the PersistenceManagerFactory.
- * @param props a Properties instance with properties of the PersistenceManagerFactory.
- * @param cl the class loader to use to load the PersistenceManagerFactory class
+ * @param props a Properties instance with properties of the
+ * PersistenceManagerFactory.
+ * @param cl the class loader to use to load the
+ * PersistenceManagerFactory class
*/
public static PersistenceManagerFactory getPersistenceManagerFactory
(Map props, ClassLoader cl) {
@@ -561,7 +566,8 @@
* be wrapped in a {@link JDOFatalUserException}.
* @since 2.0
* @param propsResource the resource containing the Properties
- * @param loader the class loader to use to load both the propsResource and the PersistenceManagerFactory class
+ * @param loader the class loader to use to load both the propsResource and
+ * the PersistenceManagerFactory class
* @return the PersistenceManagerFactory
*/
public static PersistenceManagerFactory getPersistenceManagerFactory
@@ -580,7 +586,8 @@
* @since 2.0
* @param propsResource the resource containing the Properties
* @param propsLoader the class loader to use to load the propsResource
- * @param pmfLoader the class loader to use to load the PersistenceManagerFactory class
+ * @param pmfLoader the class loader to use to load the
+ * PersistenceManagerFactory class
* @return the PersistenceManagerFactory
*/
public static PersistenceManagerFactory getPersistenceManagerFactory
@@ -644,7 +651,8 @@
* loading will be wrapped in a {@link JDOFatalUserException}.
* @since 2.0
* @param propsFile the file containing the Properties
- * @param loader the class loader to use to load the PersistenceManagerFactory class
+ * @param loader the class loader to use to load the
+ * PersistenceManagerFactory class
* @return the PersistenceManagerFactory
*/
public static PersistenceManagerFactory getPersistenceManagerFactory
@@ -705,7 +713,8 @@
* @since 2.0
* @param jndiLocation the JNDI location containing the PersistenceManagerFactory
* @param context the context in which to find the named PersistenceManagerFactory
- * @param loader the class loader to use to load the PersistenceManagerFactory class
+ * @param loader the class loader to use to load the
+ * PersistenceManagerFactory class
* @return the PersistenceManagerFactory
*/
public static PersistenceManagerFactory getPersistenceManagerFactory
@@ -754,7 +763,8 @@
* loading will be wrapped in a {@link JDOFatalUserException}.
* @since 2.0
* @param stream the stream containing the Properties
- * @param loader the class loader to use to load the PersistenceManagerFactory class
+ * @param loader the class loader to use to load the
+ * PersistenceManagerFactory class
* @return the PersistenceManagerFactory
*/
public static PersistenceManagerFactory getPersistenceManagerFactory
Index: src/java/javax/jdo/PersistenceManager.java
===================================================================
--- src/java/javax/jdo/PersistenceManager.java (Revision 389512)
+++ src/java/javax/jdo/PersistenceManager.java (Arbeitskopie)
@@ -28,10 +28,10 @@
import javax.jdo.listener.InstanceLifecycleListener;
-/** PersistenceManager is the primary interface for JDO-aware application
- * components. It is the factory for Query and Transaction instances,
- * and contains methods to manage the life cycle of PersistenceCapable
- * instances.
+/** PersistenceManager is the primary interface for JDO-aware
+ * application components. It is the factory for Query and
+ * Transaction instances, and contains methods to manage the
+ * life cycle of PersistenceCapable instances.
*
* PersistenceManager is obtained from the
* {@link PersistenceManagerFactory}
@@ -47,13 +47,13 @@
*/
boolean isClosed ();
- /** Close this PersistenceManager so that no further requests may be
- * made on it. A PersistenceManager instance can be used
+ /** Close this PersistenceManager so that no further requests
+ * may be made on it. A PersistenceManager instance can be used
* only until it is closed.
*
- * PersistenceManager might release it to the pool of available
- * PersistenceManagers, or might be garbage collected, at the option of
- * the JDO implementation. Before being used again to satisfy a
+ * PersistenceManager might release it to the pool
+ * of available PersistenceManagers, or might be garbage collected,
+ * at the option of the JDO implementation. Before being used again to satisfy a
* getPersistenceManager() request, the default values for options will
* be restored to their values as specified in the PersistenceManagerFactory.
*
@@ -61,9 +61,10 @@
*/
void close ();
- /** Return the Transaction instance associated with a PersistenceManager.
- * There is one Transaction instance associated with each PersistenceManager
- * instance. The Transaction instance supports options as well as
+ /** Return the Transaction instance associated with a
+ * PersistenceManager. There is one Transaction
+ * instance associated with each PersistenceManager instance.
+ * The Transaction instance supports options as well as
* transaction completion requests.
* @return the Transaction associated with this
* PersistenceManager.
@@ -73,8 +74,8 @@
/** Mark an instance as no longer needed in the cache.
* Eviction is normally done automatically by the PersistenceManager
* at transaction completion. This method allows the application to
- * explicitly provide a hint to the PersistenceManager that the instance
- * is no longer needed in the cache.
+ * explicitly provide a hint to the PersistenceManager that the
+ * instance is no longer needed in the cache.
* @param pc the instance to evict from the cache.
*/
void evict (Object pc);
@@ -144,12 +145,13 @@
*/
Query newQuery ();
- /** Create a new Query using elements from another Query.
- * The other Query must have been created by the same JDO implementation.
- * It might be active
- * in a different PersistenceManager or might have been serialized and restored.
- * Query are copied to this Query,
- * except for the candidate Collection or Extent.
+ /** Create a new Query using elements from another
+ * Query. The other Query must have been created
+ * by the same JDO implementation. It might be active in a different
+ * PersistenceManager or might have been serialized and restored.
+ * Query are copied to this
+ * Query, except for the candidate Collection or
+ * Extent.
* @return the new Query
* @param compiled another Query from the same JDO implementation
*/
@@ -170,7 +172,8 @@
*/
Query newQuery (String language, Object query);
- /** Create a new Query specifying the Class of the candidate instances.
+ /** Create a new Query specifying the Class of the
+ * candidate instances.
* @param cls the Class of the candidate instances
* @return the new Query
*/
@@ -199,7 +202,8 @@
*/
Query newQuery (Class cls, String filter);
- /** Create a new Query with the Class of the candidate instances,
+ /** Create a new Query with the Class of the
+ * candidate instances,
* candidate Collection, and filter.
* @param cls the Class of candidate instances
* @param cln the Collection of candidate instances
@@ -227,11 +231,11 @@
*/
Query newNamedQuery (Class cls, String queryName);
- /** The PersistenceManager manages a collection of instances in the data
- * store based on the class of the instances. This method returns an
+ /** The PersistenceManager manages a collection of instances in
+ * the data store based on the class of the instances. This method returns an
* Extent of instances in the data store that might be iterated or
- * given to a Query. The Extent itself might not reference any
- * instances, but only hold the class name and an
+ * given to a Query. The Extent itself might not
+ * reference any instances, but only hold the class name and an
* indicator as to whether subclasses are included in the Extent.
* Extent might be very large.
* @param persistenceCapableClass Class of instances
@@ -253,18 +257,19 @@
* managed by this PersistenceManager.
* The getObjectById method attempts
* to find an instance in the cache with the specified JDO identity.
- * The oid parameter object might have been returned by an earlier call
- * to getObjectId or getTransactionalObjectId,
+ * The oid parameter object might have been returned by an earlier
+ * call to getObjectId or getTransactionalObjectId,
* or might have been constructed by the application.
- * PersistenceManager is unable to resolve the oid parameter
- * to an ObjectId instance, then it throws a JDOUserException.
- * validate flag is false, and there is already an instance in the
- * cache with the same JDO identity as the oid parameter, then this method
- * returns it. There is no change made to the state of the returned
- * instance.
+ * PersistenceManager is unable to resolve the
+ * oid parameter to an ObjectId instance, then it throws a
+ * JDOUserException.
+ * validate flag is false, and there is
+ * already an instance in the cache with the same JDO identity as the
+ * oid parameter, then this method returns it. There is no
+ * change made to the state of the returned instance.
* oid parameter, then this method creates an instance
- * with the specified JDO identity and returns it. If there is no
+ * identity as the oid parameter, then this method creates an
+ * instance with the specified JDO identity and returns it. If there is no
* transaction in progress, the returned instance will be hollow or
* persistent-nontransactional, at the choice of the implementation.
* PersistenceCapable classes share the
- * same ObjectId class.
- * false, and the instance does not exist in
- * the data store, then this method might not fail. It is an
+ * inheritance, where multiple PersistenceCapable classes share
+ * the same ObjectId class.
+ * false, and the instance does not
+ * exist in the data store, then this method might not fail. It is an
* implementation choice whether to fail immediately with a
* JDOObjectNotFoundException. But a subsequent access
* of the fields of the
@@ -284,19 +289,19 @@
* exist at that time. Further, if a relationship is established to this
* instance, then the transaction in which the association was made will
* fail.
- * validate flag is true, and there is already a transactional
- * instance in the cache with the same JDO identity as the oid parameter,
- * then this method returns it. There is no change made to the state of
- * the returned instance.
- * oid parameter, but the instance is not transactional,
+ * validate flag is true, and there is
+ * already a transactional instance in the cache with the same JDO identity
+ * as the oid parameter, then this method returns it. There is
+ * no change made to the state of the returned instance.
+ * oid parameter, but the instance is not transactional,
* then it must be verified in the data store. If the instance does not
* exist in the datastore, then a JDOObjectNotFoundException
* is thrown.
* oid parameter, then this method creates an instance
- * with the specified JDO identity, verifies that it exists in the data
- * store, and returns it. If there is no transaction in progress, the
+ * identity as the oid parameter, then this method creates an
+ * instance with the specified JDO identity, verifies that it exists in the
+ * data store, and returns it. If there is no transaction in progress, the
* returned instance will be hollow or persistent-nontransactional,
* at the choice of the implementation.
* PersistenceCapable instance with the specified ObjectId
+ * @return the PersistenceCapable instance with the specified
+ * ObjectId
* @param oid an ObjectId
* @param validate if the existence of the instance is to be validated
*/
@@ -333,11 +339,11 @@
* the instance. The ObjectId is a copy (clone) of the internal state
* of the instance, and changing it does not affect the JDO identity of
* the instance.
- * getObjectId method returns an ObjectId instance that represents
- * the object identity of the specified JDO instance. The identity is
- * guaranteed to be unique only in the context of the JDO
- * PersistenceManager that created the identity, and only for two types
- * of JDO Identity: those that are managed by the application, and
+ * getObjectId method returns an ObjectId instance that
+ * represents the object identity of the specified JDO instance. The identity
+ * is guaranteed to be unique only in the context of the JDO
+ * PersistenceManager that created the identity, and only for
+ * two types of JDO Identity: those that are managed by the application, and
* those that are managed by the data store.
* getObjectById method can be used between instances of
- * PersistenceManager of different JDO vendors only for instances of
- * persistence capable classes using application-managed (primary key)
+ * PersistenceManager of different JDO vendors only for instances
+ * of persistence capable classes using application-managed (primary key)
* JDO identity. If it is used for instances of classes using datastore
* identity, the method might succeed, but there are no guarantees that
* the parameter and return instances are related in any way.
@@ -521,12 +527,12 @@
/** Delete the persistent instance from the data store.
* This method must be called in an active transaction.
* The data store object will be removed at commit.
- * Unlike makePersistent, which makes the closure of the instance persistent,
- * the closure of the instance is not deleted from the data store.
+ * Unlike makePersistent, which makes the closure of the instance
+ * persistent, the closure of the instance is not deleted from the data store.
* This method has no effect if the instance is already deleted in the
* current transaction.
- * This method throws JDOUserException if the instance is transient or
- * is managed by another PersistenceManager.
+ * This method throws JDOUserException if the instance is
+ * transient or is managed by another PersistenceManager.
*
* @param pc a persistent instance
*/
@@ -548,16 +554,18 @@
* PersistenceManager.
*
* PersistenceManager. The state of fields is preserved unchanged.
+ * with any PersistenceManager. The state of fields is
+ * preserved unchanged.
* @param pc the instance to make transient.
*/
void makeTransient (Object pc);
- /** Make an array of instances transient, removing them from management by this
- * PersistenceManager.
+ /** Make an array of instances transient, removing them from management by
+ * this PersistenceManager.
*
* PersistenceManager. The state of fields is preserved unchanged.
+ * with any PersistenceManager. The state of fields is preserved
+ * unchanged.
* @param pcs the instances to make transient.
*/
void makeTransientAll (Object[] pcs);
@@ -566,7 +574,8 @@
* management by this PersistenceManager.
*
* PersistenceManager. The state of fields is preserved unchanged.
+ * with any PersistenceManager. The state of fields is preserved
+ * unchanged.
* @param pcs the instances to make transient.
*/
void makeTransientAll (Collection pcs);
@@ -647,8 +656,8 @@
* Collection of instances subject to transactional boundaries.
+ /** Make a Collection of instances subject to transactional
+ * boundaries.
* @param pcs the Collection of instances to make transactional.
* @see #makeTransactional(Object pc)
*/
@@ -691,68 +701,92 @@
void makeNontransactionalAll (Collection pcs);
/** Retrieve field values of an instance from the store. This tells
- * the PersistenceManager that the application intends to use the
- * instance, and its field values must be retrieved.
- * PersistenceManager might use policy information about the
- * class to retrieve associated instances.
+ * the PersistenceManager that the application intends to use
+ * the instance, and its field values must be retrieved.
+ * PersistenceManager might use policy information about
+ * the class to retrieve associated instances.
* @param pc the instance
*/
void retrieve (Object pc);
/** Retrieve field values of an instance from the store. This tells
- * the PersistenceManager that the application intends to use the
- * instance, and its field values must be retrieved.
- * PersistenceManager might use policy information about the
- * class to retrieve associated instances.
+ * the PersistenceManager that the application intends to use
+ * the instance, and its field values must be retrieved.
+ * PersistenceManager that the application intends to use the
- * instances, and all field values must be retrieved.
- * PersistenceManager might use policy information about the
- * class to retrieve associated instances.
+ * the PersistenceManager that the application intends to use
+ * the instances, and all field values must be retrieved.
+ * PersistenceManager might use policy information about
+ * the class to retrieve associated instances.
* @param pcs the instances
*/
void retrieveAll (Collection pcs);
/** Retrieve field values of instances from the store. This tells
- * the PersistenceManager that the application intends to use the
- * instances, and their field values should be retrieved. The fields
+ * the PersistenceManager that the application intends to use
+ * the instances, and their field values should be retrieved. The fields
* in the current fetch group must be retrieved, and the implementation
* might retrieve more fields than the current fetch group.
- * PersistenceManager might use policy information about the
- * class to retrieve associated instances.
+ * PersistenceManager that the application intends to use the
- * instances, and all field values must be retrieved.
- * PersistenceManager might use policy information about the
- * class to retrieve associated instances.
+ * the PersistenceManager that the application intends to use
+ * the instances, and all field values must be retrieved.
+ * PersistenceManager might use policy information about
+ * the class to retrieve associated instances.
* @param pcs the instances
*/
void retrieveAll (Object[] pcs);
/** Retrieve field values of instances from the store. This tells
- * the PersistenceManager that the application intends to use the
- * instances, and their field values should be retrieved. The fields
+ * the PersistenceManager that the application intends to use
+ * the instances, and their field values should be retrieved. The fields
* in the current fetch group must be retrieved, and the implementation
* might retrieve more fields than the current fetch group.
- * PersistenceManager might use policy information about the
- * class to retrieve associated instances.
+ * PersistenceManager instances
* more easily by having an application object associated with each
@@ -770,34 +804,36 @@
*/
Object getUserObject ();
- /** This method returns the PersistenceManagerFactory used to create
- * this PersistenceManager.
+ /** This method returns the PersistenceManagerFactory used to
+ * create this PersistenceManager.
* @return the PersistenceManagerFactory that created
* this PersistenceManager
*/
PersistenceManagerFactory getPersistenceManagerFactory();
/** Return the Class that implements the JDO Identity for the
- * specified PersistenceCapable class. The application can use the
- * returned Class to construct a JDO Identity instance for
- * application identity PersistenceCapable classes. This JDO Identity
- * instance can then be used to get an instance of the
+ * specified PersistenceCapable class. The application can use
+ * the returned Class to construct a JDO Identity instance for
+ * application identity PersistenceCapable classes. This JDO
+ * Identity instance can then be used to get an instance of the
* PersistenceCapable class for use in the application.
*
- * PersistenceCapable Class
* @return the Class of the ObjectId of the parameter
* @see #getObjectById
*/
Class getObjectIdClass(Class cls);
- /** Set the Multithreaded flag for this PersistenceManager. Applications
- * that use multiple threads to invoke methods or access fields from
- * instances managed by this PersistenceManager must set this flag to true.
- * Instances managed by this PersistenceManager include persistent or
- * transactional instances of PersistenceCapable classes, as well as
- * helper instances such as Query, Transaction, or Extent.
+ /** Set the Multithreaded flag for this PersistenceManager.
+ * Applications that use multiple threads to invoke methods or access fields
+ * from instances managed by this PersistenceManager must set
+ * this flag to true.
+ * Instances managed by this PersistenceManager include
+ * persistent or transactional instances of PersistenceCapable
+ * classes, as well as helper instances such as Query,
+ * Transaction, or Extent.
* @param flag the Multithreaded setting.
*/
void setMultithreaded (boolean flag);
@@ -810,16 +846,18 @@
/** Set the ignoreCache parameter for queries.
*
- * true specifies that for all Query instances created by this
- * PersistenceManager, the default is the cache should be ignored for queries.
+ * true specifies that for all
+ * Query instances created by this PersistenceManager,
+ * the default is the cache should be ignored for queries.
* @param flag the ignoreCache setting.
*/
void setIgnoreCache(boolean flag);
/** Get the ignoreCache setting for queries.
*
- * true specifies that for all Query instances created by this
- * PersistenceManager, the default is the cache should be ignored for queries.
+ * true specifies that for all
+ * Query instances created by this PersistenceManager,
+ * the default is the cache should be ignored for queries.
* @return the ignoreCache setting.
*/
boolean getIgnoreCache();
Index: src/java/javax/jdo/Transaction.java
===================================================================
--- src/java/javax/jdo/Transaction.java (Revision 389512)
+++ src/java/javax/jdo/Transaction.java (Arbeitskopie)
@@ -161,30 +161,33 @@
*/
boolean getOptimistic();
- /** The user can specify a Synchronization instance to be notified on
- * transaction completions. The beforeCompletion method is called prior
- * to flushing instances to the data store.
+ /** The user can specify a Synchronization instance to be notified
+ * on transaction completions. The beforeCompletion method is
+ * called prior to flushing instances to the data store.
*
* afterCompletion method is called after performing state
* transitions of persistent and transactional instances, following
* the data store commit or rollback operation.
- * Synchronization instance can be registered with the
- * Transaction. If the application requires more than one instance to
- * receive synchronization callbacks, then the single application instance
- * is responsible for managing them, and forwarding callbacks to them.
- * @param sync the Synchronization instance to be notified; null for none
+ * Synchronization instance can be registered with
+ * the Transaction. If the application requires more than one
+ * instance to receive synchronization callbacks, then the single application
+ * instance is responsible for managing them, and forwarding callbacks to them.
+ * @param sync the Synchronization instance to be notified;
+ * null for none
*/
void setSynchronization(Synchronization sync);
- /** The user-specified Synchronization instance for this Transaction instance.
+ /** The user-specified Synchronization instance for this
+ * Transaction instance.
* @return the user-specified Synchronization instance.
*/
Synchronization getSynchronization();
- /** The Transaction instance is always associated with exactly one
- * PersistenceManager.
+ /** The Transaction instance is always associated with exactly
+ * one PersistenceManager.
*
- * @return the PersistenceManager for this Transaction instance
+ * @return the PersistenceManager for this
+ * Transaction instance
*/
PersistenceManager getPersistenceManager();
}