You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jdo-commits@db.apache.org by mb...@apache.org on 2006/03/29 00:14:17 UTC
svn commit: r389615 [2/3] - in /db/jdo/trunk/api20/src/java/javax/jdo: ./
datastore/ identity/ listener/ spi/
Modified: db/jdo/trunk/api20/src/java/javax/jdo/Query.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/Query.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/Query.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/Query.java Tue Mar 28 14:14:14 2006
@@ -28,14 +28,15 @@
* instances, values, and aggregate data
* from the data store.
*
- * The {@link PersistenceManager} is the factory for <code>Query</code> instances. There
- * may be many <code>Query</code> instances associated with a <code>PersistenceManager</code>.
- * 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 <code>Query</code>
+ * instances. There may be many <code>Query</code> instances associated with a
+ * <code>PersistenceManager</code>. 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.
*
- * <P>There are three required elements in a <code>Query</code>: the class of the results,
- * the candidate collection of instances, and the filter.
+ * <P>There are three required elements in a <code>Query</code>: the class of
+ * the results, the candidate collection of instances, and the filter.
*
* <P>There are optional elements: parameter declarations, variable
* declarations, import statements, ordering and grouping specifications,
@@ -45,29 +46,33 @@
* <P>The query namespace is modeled after methods in Java:
* <ul>
* <li><code>setClass</code> corresponds to the class definition
- * <li><code>declareParameters</code> corresponds to formal parameters of a method
+ * <li><code>declareParameters</code> corresponds to formal parameters of a
+ * method
* <li><code>declareVariables</code> corresponds to local variables of a method
- * <li><code>setFilter</code> and <code>setOrdering</code> correspond to the method body
+ * <li><code>setFilter</code> and <code>setOrdering</code> correspond to the
+ * method body
* </ul>
* <P>There are two namespaces in queries. Type names have their own
* namespace that is separate from the namespace for fields, variables
* and parameters.
- * <P>The method <code>setClass</code> introduces the name of the candidate class in
- * the type namespace. The method <code>declareImports</code> introduces the names of
- * the imported class or interface types in the type namespace. Imported
- * type names must be unique. When used (e.g. in a parameter declaration,
- * cast expression, etc.) a type name must be the name of the candidate
- * class, the name of a class or interface imported by method
+ * <P>The method <code>setClass</code> introduces the name of the candidate
+ * class in the type namespace. The method <code>declareImports</code>
+ * introduces the names of the imported class or interface types in the type
+ * namespace. Imported type names must be unique. When used (e.g. in a parameter
+ * declaration, cast expression, etc.) a type name must be the name of the
+ * candidate class, the name of a class or interface imported by method
* <code>declareImports</code>, or denote a class or interface from the same
* package as the candidate class.
- * <P>The method <code>setClass</code> introduces the names of the candidate class fields.
+ * <P>The method <code>setClass</code> introduces the names of the candidate
+ * class fields.
* <P>The method <code>declareParameters</code> introduces the names of the
- * parameters. A name introduced by <code>declareParameters</code> hides the name
- * of a candidate class field of the same name. Parameter names must be unique.
- * <P>The method <code>declareVariables</code> introduces the names of the variables.
- * A name introduced by <code>declareVariables</code> hides the name of a candidate
- * class field if equal. Variable names must be unique and must not
- * conflict with parameter names.
+ * parameters. A name introduced by <code>declareParameters</code> hides the
+ * name of a candidate class field of the same name. Parameter names must be
+ * unique.
+ * <P>The method <code>declareVariables</code> introduces the names of the
+ * variables. A name introduced by <code>declareVariables</code> hides the name
+ * of a candidate class field if equal. Variable names must be unique and must
+ * not conflict with parameter names.
* <P>The result of the query by default is a list of result class instances,
* but might be specified via <code>setResult</code>. The class of the result
* by default is the candidate class, but might be specified via
@@ -78,26 +83,23 @@
* based on the parameters given. They return a single instance or a
* <code>List</code> of result class instances which the
* user can iterate to get results. The signature
- * of the <code>execute</code> methods specifies that they return an <code>Object</code> which
- * must be cast to the appropriate result by the user.
- * <P>Any parameters passed to the <code>execute</code> methods are used only for
- * this execution, and are not remembered for future execution.
+ * of the <code>execute</code> methods specifies that they return an
+ * <code>Object</code> which must be cast to the appropriate result by the user.
+ * <P>Any parameters passed to the <code>execute</code> methods are used only
+ * for this execution, and are not remembered for future execution.
* @version 2.0
*/
public interface Query extends Serializable {
/**
- * The string constant used as the first argument to {@link
- * PersistenceManager#newQuery(String,Object)} to identify that
- * the created query should obey the JDOQL syntax and semantic
- * rules.
- * <p>This is the default query language used when creating a
- * query with any of the other {@link
- * PersistenceManager#newQuery} methods, except {@link
- * PersistenceManager#newQuery(Object)}, which uses the query
- * language of the compiled query template object passed to that
- * method.</p>
+ * The string constant used as the first argument to
+ * {@link PersistenceManager#newQuery(String,Object)} to identify that the
+ * created query should obey the JDOQL syntax and semantic rules.
+ * <p>This is the default query language used when creating a query with any
+ * of the other {@link PersistenceManager#newQuery} methods, except
+ * {@link PersistenceManager#newQuery(Object)}, which uses the query
+ * language of the compiled query template object passed to that method.</p>
* @since 2.0
*/
String JDOQL = "javax.jdo.query.JDOQL";
@@ -143,7 +145,8 @@
* then it defaults to "true", which has the effect of filtering
* the input <code>Collection</code> only for class type.
* <P>An element of the candidate collection is returned in the result if:
- * <ul><li>it is assignment compatible to the candidate <code>Class</code> of the <code>Query</code>; and
+ * <ul><li>it is assignment compatible to the candidate <code>Class</code>
+ * of the <code>Query</code>; and
* <li>for all variables there exists a value for which the filter
* expression evaluates to <code>true</code>.
* </ul>
@@ -154,31 +157,32 @@
* <ul>
* <li>Equality and ordering comparisons between primitives and instances
* of wrapper classes are valid.
- * <li>Equality and ordering comparisons of <code>Date</code> fields and <code>Date</code>
- * parameters are valid.
+ * <li>Equality and ordering comparisons of <code>Date</code> fields and
+ * <code>Date</code> parameters are valid.
* <li>White space (non-printing characters space, tab, carriage
* return, and line feed) is a separator and is otherwise ignored.
- * <li>The assignment operators <code>=</code>, <code>+=</code>, etc. and pre- and post-increment
- * and -decrement are not supported. Therefore, there are no side
- * effects from evaluation of any expressions.
+ * <li>The assignment operators <code>=</code>, <code>+=</code>, etc. and
+ * pre- and post-increment and -decrement are not supported. Therefore,
+ * there are no side effects from evaluation of any expressions.
* <li>Methods, including object construction, are not supported, except
- * for <code>Collection.contains(Object o)</code>, <code>Collection.isEmpty()</code>,
- * <code>String.startsWith(String s)</code>, and <code>String.endsWith(String e)</code>.
- * Implementations might choose to support non-mutating method
- * calls as non-standard extensions.
- * <li>Navigation through a <code>null</code>-valued field, which would throw
- * <code>NullPointerException</code>, is treated as if the filter expression
- * returned <code>false</code> 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.
- * <li>Navigation through multi-valued fields (<code>Collection</code> types) is
- * specified using a variable declaration and the
+ * for <code>Collection.contains(Object o)</code>,
+ * <code>Collection.isEmpty()</code>,
+ * <code>String.startsWith(String s)</code>, and
+ * <code>String.endsWith(String e)</code>. Implementations might choose to
+ * support non-mutating method calls as non-standard extensions.
+ * <li>Navigation through a <code>null</code>-valued field, which would
+ * throw <code>NullPointerException</code>, is treated as if the filter
+ * expression returned <code>false</code> 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.
+ * <li>Navigation through multi-valued fields (<code>Collection</code>
+ * types) is specified using a variable declaration and the
* <code>Collection.contains(Object o)</code> method.
* </ul>
* <P>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, <code>this</code> is a reserved
- * word which means the element of the collection being evaluated.
+ * parameters and variables. As in the Java language, <code>this</code> is a
+ * reserved word which means the element of the collection being evaluated.
* <P>Navigation through single-valued fields is specified by the Java
* language syntax of <code>field_name.field_name....field_name</code>.
* <P>A JDO implementation is allowed to reorder the filter expression
@@ -187,43 +191,43 @@
*/
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 <code>String</code> with semicolon-separated
- * statements.
- * <P>The <code>String</code> parameter to this method follows the syntax of the
- * import statement of the Java language.
+ * Import statements are specified as a <code>String</code> with
+ * semicolon-separated statements.
+ * <P>The <code>String</code> 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 <code>String</code> containing one or more query
- * parameter declarations separated with commas. Each parameter named
+ * The parameter declaration is a <code>String</code> 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.
- * <P>The <code>String</code> parameter to this method follows the syntax for formal
- * parameters in the Java language.
+ * <P>The <code>String</code> 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);
/** Declare the unbound variables to be used in the query. Variables
* might be used in the filter, and these variables must be declared
- * with their type. The unbound variable declaration is a <code>String</code>
- * containing one or more unbound variable declarations separated
- * with semicolons. It follows the syntax for local variables in
+ * with their type. The unbound variable declaration is a
+ * <code>String</code> containing one or more unbound variable declarations
+ * separated with semicolons. It follows the syntax for local variables in
* the Java language.
* @param variables the variables separated by semicolons.
*/
void declareVariables(String variables);
- /** Set the ordering specification for the result <code>Collection</code>. The
- * ordering specification is a <code>String</code> containing one or more ordering
- * declarations separated by commas.
+ /** Set the ordering specification for the result <code>Collection</code>.
+ * The ordering specification is a <code>String</code> containing one or
+ * more ordering declarations separated by commas.
*
* <P>Each ordering declaration is the name of the field on which
* to order the results followed by one of the following words:
@@ -232,9 +236,9 @@
*<P>The field must be declared in the candidate class or must be
* a navigation expression starting with a field in the candidate class.
*
- *<P>Valid field types are primitive types except <code>boolean</code>; wrapper types
- * except <code>Boolean</code>; <code>BigDecimal</code>; <code>BigInteger</code>;
- * <code>String</code>; and <code>Date</code>.
+ *<P>Valid field types are primitive types except <code>boolean</code>;
+ * wrapper types except <code>Boolean</code>; <code>BigDecimal</code>;
+ * <code>BigInteger</code>; <code>String</code>; and <code>Date</code>.
* @param ordering the ordering specification.
*/
void setOrdering(String ordering);
@@ -245,8 +249,8 @@
*
* The ignoreCache option setting specifies whether the query should execute
* entirely in the back end, instead of in the cache. If this flag is set
- * to <code>true</code>, an implementation might be able to optimize the query
- * execution by ignoring changed values in the cache. For optimistic
+ * to <code>true</code>, an implementation might be able to optimize the
+ * query execution by ignoring changed values in the cache. For optimistic
* transactions, this can dramatically improve query response times.
* @param ignoreCache the setting of the ignoreCache option.
*/
@@ -293,12 +297,13 @@
*/
Object execute(Object p1, Object p2, Object p3);
- /** Execute the query and return the filtered <code>Collection</code>. The query
- * is executed with the parameters set by the <code>Map</code> values. Each <code>Map</code> entry
- * consists of a key which is the name of the parameter in the
- * <code>declareParameters</code> method, and a value which is the value used in
- * the <code>execute</code> method. The keys in the <code>Map</code> and the declared parameters
- * must exactly match or a <code>JDOUserException</code> is thrown.
+ /** Execute the query and return the filtered <code>Collection</code>. The
+ * query is executed with the parameters set by the <code>Map</code> values.
+ * Each <code>Map</code> entry consists of a key which is the name of the
+ * parameter in the <code>declareParameters</code> method, and a value which
+ * is the value used in the <code>execute</code> method. The keys in the
+ * <code>Map</code> and the declared parameters must exactly match or a
+ * <code>JDOUserException</code> is thrown.
* @return the filtered <code>Collection</code>.
* @see #executeWithArray(Object[] parameters)
* @param parameters the <code>Map</code> containing all of the parameters.
@@ -317,36 +322,43 @@
* <P>The filter, import, declared parameters, declared variables, and
* ordering statements are verified for consistency.
*
- * <P>Each element in the candidate <code>Collection</code> is examined to see that it
- * is assignment compatible to the <code>Class</code> 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 <code>true</code>.
+ * <P>Each element in the candidate <code>Collection</code> is examined to
+ * see that it is assignment compatible to the <code>Class</code> 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 <code>true</code>.
* @return the filtered <code>Collection</code>.
- * @param parameters the <code>Object</code> array with all of the parameters.
+ * @param parameters the <code>Object</code> array with all of the
+ * parameters.
*/
Object executeWithArray (Object[] parameters);
- /** Get the <code>PersistenceManager</code> associated with this <code>Query</code>.
+ /** Get the <code>PersistenceManager</code> associated with this
+ * <code>Query</code>.
*
- * <P>If this <code>Query</code> was restored from a serialized form, it has no
- * <code>PersistenceManager</code>, and this method returns <code>null</code>.
- * @return the <code>PersistenceManager</code> associated with this <code>Query</code>.
+ * <P>If this <code>Query</code> was restored from a serialized form, it has
+ * no <code>PersistenceManager</code>, and this method returns
+ * <code>null</code>.
+ * @return the <code>PersistenceManager</code> associated with this
+ * <code>Query</code>.
*/
PersistenceManager getPersistenceManager();
/** Close a query result and release any resources associated with it. The
- * parameter is the return from <code>execute(...)</code> and might have iterators open on it.
- * Iterators associated with the query result are invalidated: they return <code>false</code>
- * to <code>hasNext()</code> and throw <code>NoSuchElementException</code> to <code>next()</code>.
- * @param queryResult the result of <code>execute(...)</code> on this <code>Query</code> instance.
+ * parameter is the return from <code>execute(...)</code> and might have
+ * iterators open on it. Iterators associated with the query result are
+ * invalidated: they return <code>false</code> to <code>hasNext()</code>
+ * and throw <code>NoSuchElementException</code> to <code>next()</code>.
+ * @param queryResult the result of <code>execute(...)</code> on this
+ * <code>Query</code> instance.
*/
void close (Object queryResult);
- /** Close all query results associated with this <code>Query</code> 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 <code>false</code> to <code>hasNext()</code> and throw
+ /** Close all query results associated with this <code>Query</code>
+ * 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 <code>false</code> to <code>hasNext()</code> and throw
* <code>NoSuchElementException</code> to <code>next()</code>.
*/
void closeAll ();
@@ -417,7 +429,8 @@
* requirements apply:
* <ul>
* <li>A user-defined result class must have a no-args constructor and
- * one or more public <code>set</code> or <code>put</code> methods or fields.
+ * one or more public <code>set</code> or <code>put</code> methods or
+ * fields.
* <li>Each result expression must match one of:
* <ul>
* <li>a public field that matches the name of the result expression
@@ -571,4 +584,3 @@
boolean isUnmodifiable();
}
-
Modified: db/jdo/trunk/api20/src/java/javax/jdo/Transaction.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/Transaction.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/Transaction.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/Transaction.java Tue Mar 28 14:14:14 2006
@@ -22,8 +22,8 @@
package javax.jdo;
import javax.transaction.Synchronization;
-/** The JDO <code>Transaction</code> interface provides for initiation and completion
- * of transactions under user control.
+/** The JDO <code>Transaction</code> interface provides for initiation and
+ * completion of transactions under user control.
* It is a sub-interface of the {@link PersistenceManager}
* that deals with options and transaction demarcation.
* <P>Transaction options include whether optimistic concurrency
@@ -35,7 +35,8 @@
* <P>Transaction initiation and completion methods have similar semantics to
* <code>javax.transaction.UserTransaction</code> when used outside a managed
* environment. When used in a managed environment, transaction initiation
- * and completion methods may only be used with bean-managed transaction semantics.
+ * and completion methods may only be used with bean-managed transaction
+ * semantics.
* @version 2.0
*/
@@ -91,7 +92,8 @@
* a transaction active.
* If an implementation does not support this option, a
* <code>JDOUnsupportedOptionException</code> is thrown.
- * @param nontransactionalRead the value of the nontransactionalRead property
+ * @param nontransactionalRead the value of the nontransactionalRead
+ * property
*/
void setNontransactionalRead (boolean nontransactionalRead);
@@ -105,7 +107,8 @@
* a transaction active.
* If an implementation does not support this option, a
* <code>JDOUnsupportedOptionException</code> is thrown.
- * @param nontransactionalWrite the value of the nontransactionalRead property
+ * @param nontransactionalWrite the value of the nontransactionalRead
+ * property
*/
void setNontransactionalWrite (boolean nontransactionalWrite);
@@ -115,15 +118,16 @@
*/
boolean getNontransactionalWrite ();
- /** If <code>true</code>, at commit instances retain their values and the instances
- * transition to persistent-nontransactional.
+ /** If <code>true</code>, at commit instances retain their values and the
+ * instances transition to persistent-nontransactional.
* If an implementation does not support this option, a
* <code>JDOUnsupportedOptionException</code> is thrown.
* @param retainValues the value of the retainValues property
*/
void setRetainValues(boolean retainValues);
- /** If <code>true</code>, at commit time instances retain their field values.
+ /** If <code>true</code>, at commit time instances retain their field
+ * values.
* @return the value of the retainValues property
*/
boolean getRetainValues();
@@ -161,30 +165,34 @@
*/
boolean getOptimistic();
- /** The user can specify a <code>Synchronization</code> instance to be notified on
- * transaction completions. The <code>beforeCompletion</code> method is called prior
- * to flushing instances to the data store.
+ /** The user can specify a <code>Synchronization</code> instance to be
+ * notified on transaction completions. The <code>beforeCompletion</code>
+ * method is called prior to flushing instances to the data store.
*
- * <P>The <code>afterCompletion</code> method is called after performing state
- * transitions of persistent and transactional instances, following
+ * <P>The <code>afterCompletion</code> method is called after performing
+ * state transitions of persistent and transactional instances, following
* the data store commit or rollback operation.
- * <P>Only one <code>Synchronization</code> instance can be registered with the
- * <code>Transaction</code>. 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 <code>Synchronization</code> instance to be notified; <code>null</code> for none
+ * <P>Only one <code>Synchronization</code> instance can be registered with
+ * the <code>Transaction</code>. 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 <code>Synchronization</code> instance to be notified;
+ * <code>null</code> for none
*/
void setSynchronization(Synchronization sync);
- /** The user-specified <code>Synchronization</code> instance for this <code>Transaction</code> instance.
+ /** The user-specified <code>Synchronization</code> instance for this
+ * <code>Transaction</code> instance.
* @return the user-specified <code>Synchronization</code> instance.
*/
Synchronization getSynchronization();
- /** The <code>Transaction</code> instance is always associated with exactly one
- * <code>PersistenceManager</code>.
+ /** The <code>Transaction</code> instance is always associated with exactly
+ * one <code>PersistenceManager</code>.
*
- * @return the <code>PersistenceManager</code> for this <code>Transaction</code> instance
+ * @return the <code>PersistenceManager</code> for this
+ * <code>Transaction</code> instance
*/
PersistenceManager getPersistenceManager();
}
Modified: db/jdo/trunk/api20/src/java/javax/jdo/datastore/JDOConnection.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/datastore/JDOConnection.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/datastore/JDOConnection.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/datastore/JDOConnection.java Tue Mar 28 14:14:14 2006
@@ -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
*/
Modified: db/jdo/trunk/api20/src/java/javax/jdo/datastore/Sequence.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/datastore/Sequence.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/datastore/Sequence.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/datastore/Sequence.java Tue Mar 28 14:14:14 2006
@@ -79,4 +79,4 @@
* @return the current value
*/
long currentValue();
-}
\ No newline at end of file
+}
Modified: db/jdo/trunk/api20/src/java/javax/jdo/identity/ObjectIdentity.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/identity/ObjectIdentity.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/identity/ObjectIdentity.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/identity/ObjectIdentity.java Tue Mar 28 14:14:14 2006
@@ -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
Modified: db/jdo/trunk/api20/src/java/javax/jdo/identity/StringIdentity.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/identity/StringIdentity.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/identity/StringIdentity.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/identity/StringIdentity.java Tue Mar 28 14:14:14 2006
@@ -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
*/
Modified: db/jdo/trunk/api20/src/java/javax/jdo/listener/AttachCallback.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/listener/AttachCallback.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/listener/AttachCallback.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/listener/AttachCallback.java Tue Mar 28 14:14:14 2006
@@ -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,18 +30,19 @@
/**
* This method is called during the execution of
- * {@link PersistenceManager#makePersistent} on the detached instance
- * before the copy is made.
+ * {@link javax.jdo.PersistenceManager#makePersistent} on the detached
+ * instance before the copy is made.
* @since 2.0
*/
public void jdoPreAttach();
/**
* 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);
Modified: db/jdo/trunk/api20/src/java/javax/jdo/listener/AttachLifecycleListener.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/listener/AttachLifecycleListener.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/listener/AttachLifecycleListener.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/listener/AttachLifecycleListener.java Tue Mar 28 14:14:14 2006
@@ -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
Modified: db/jdo/trunk/api20/src/java/javax/jdo/listener/ClearLifecycleListener.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/listener/ClearLifecycleListener.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/listener/ClearLifecycleListener.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/listener/ClearLifecycleListener.java Tue Mar 28 14:14:14 2006
@@ -55,4 +55,4 @@
* @since 2.0
*/
void postClear (InstanceLifecycleEvent event);
-}
\ No newline at end of file
+}
Modified: db/jdo/trunk/api20/src/java/javax/jdo/listener/CreateLifecycleListener.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/listener/CreateLifecycleListener.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/listener/CreateLifecycleListener.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/listener/CreateLifecycleListener.java Tue Mar 28 14:14:14 2006
@@ -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
+}
Modified: db/jdo/trunk/api20/src/java/javax/jdo/listener/DeleteLifecycleListener.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/listener/DeleteLifecycleListener.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/listener/DeleteLifecycleListener.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/listener/DeleteLifecycleListener.java Tue Mar 28 14:14:14 2006
@@ -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.
* <P>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}.
* <P>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
+}
Modified: db/jdo/trunk/api20/src/java/javax/jdo/listener/DetachCallback.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/listener/DetachCallback.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/listener/DetachCallback.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/listener/DetachCallback.java Tue Mar 28 14:14:14 2006
@@ -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
Modified: db/jdo/trunk/api20/src/java/javax/jdo/listener/DetachLifecycleListener.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/listener/DetachLifecycleListener.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/listener/DetachLifecycleListener.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/listener/DetachLifecycleListener.java Tue Mar 28 14:14:14 2006
@@ -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.
Modified: db/jdo/trunk/api20/src/java/javax/jdo/listener/DirtyLifecycleListener.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/listener/DirtyLifecycleListener.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/listener/DirtyLifecycleListener.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/listener/DirtyLifecycleListener.java Tue Mar 28 14:14:14 2006
@@ -45,4 +45,4 @@
* @since 2.0
*/
void postDirty (InstanceLifecycleEvent event);
-}
\ No newline at end of file
+}
Modified: db/jdo/trunk/api20/src/java/javax/jdo/listener/InstanceLifecycleEvent.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/listener/InstanceLifecycleEvent.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/listener/InstanceLifecycleEvent.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/listener/InstanceLifecycleEvent.java Tue Mar 28 14:14:14 2006
@@ -119,7 +119,8 @@
* <code>getPersistentInstance()</code> and
* <code>getDetachedInstance()</code> 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
+}
Modified: db/jdo/trunk/api20/src/java/javax/jdo/listener/InstanceLifecycleListener.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/listener/InstanceLifecycleListener.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/listener/InstanceLifecycleListener.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/listener/InstanceLifecycleListener.java Tue Mar 28 14:14:14 2006
@@ -31,4 +31,4 @@
* @since 2.0
*/
public interface InstanceLifecycleListener {
-}
\ No newline at end of file
+}
Modified: db/jdo/trunk/api20/src/java/javax/jdo/listener/LoadLifecycleListener.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/listener/LoadLifecycleListener.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/listener/LoadLifecycleListener.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/listener/LoadLifecycleListener.java Tue Mar 28 14:14:14 2006
@@ -38,4 +38,4 @@
* @since 2.0
*/
void postLoad (InstanceLifecycleEvent event);
-}
\ No newline at end of file
+}
Modified: db/jdo/trunk/api20/src/java/javax/jdo/listener/StoreLifecycleListener.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/listener/StoreLifecycleListener.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/listener/StoreLifecycleListener.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/listener/StoreLifecycleListener.java Tue Mar 28 14:14:14 2006
@@ -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
+}
Modified: db/jdo/trunk/api20/src/java/javax/jdo/spi/I18NHelper.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/spi/I18NHelper.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/spi/I18NHelper.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/spi/I18NHelper.java Tue Mar 28 14:14:14 2006
@@ -39,7 +39,8 @@
* Subsequently, instance methods can be used to format message strings
* using the text from the bundle, as in
* <P>
- * <code>throw new JDOFatalInternalException (msg.msg("ERR_NoMetadata", cls.getName()));</code>
+ * <code>throw new JDOFatalInternalException (msg.msg("ERR_NoMetadata",
+ * cls.getName()));</code>
* @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; i<msgArgs.length; i++) {
if (msgArgs[i] == null) msgArgs[i] = ""; // NOI18N
@@ -307,7 +309,8 @@
* @param arg the argument
* @return the resolved message text
*/
- final private static String getMessage(ResourceBundle messages, String messageKey, Object arg)
+ final private static String getMessage(ResourceBundle messages,
+ String messageKey, Object arg)
{
Object []args = {arg};
return getMessage(messages, messageKey, args);
@@ -321,8 +324,8 @@
* @param arg2 the second argument
* @return the resolved message text
*/
- final private static String getMessage(ResourceBundle messages, String messageKey, Object arg1,
- Object arg2)
+ final private static String getMessage(ResourceBundle messages,
+ String messageKey, Object arg1, Object arg2)
{
Object []args = {arg1, arg2};
return getMessage(messages, messageKey, args);
@@ -337,8 +340,8 @@
* @param arg3 the third argument
* @return the resolved message text
*/
- final private static String getMessage(ResourceBundle messages, String messageKey, Object arg1,
- Object arg2, Object arg3)
+ final private static String getMessage(ResourceBundle messages,
+ String messageKey, Object arg1, Object arg2, Object arg3)
{
Object []args = {arg1, arg2, arg3};
return getMessage(messages, messageKey, args);
@@ -351,7 +354,8 @@
* @param arg the argument
* @return the resolved message text
*/
- final private static String getMessage(ResourceBundle messages, String messageKey, int arg)
+ final private static String getMessage(ResourceBundle messages,
+ String messageKey, int arg)
{
Object []args = {new Integer(arg)};
return getMessage(messages, messageKey, args);
@@ -364,7 +368,8 @@
* @param arg the argument
* @return the resolved message text
*/
- final private static String getMessage(ResourceBundle messages, String messageKey, boolean arg)
+ final private static String getMessage(ResourceBundle messages,
+ String messageKey, boolean arg)
{
Object []args = {String.valueOf(arg)};
return getMessage(messages, messageKey, args);
Modified: db/jdo/trunk/api20/src/java/javax/jdo/spi/JDOImplHelper.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/spi/JDOImplHelper.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/spi/JDOImplHelper.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/spi/JDOImplHelper.java Tue Mar 28 14:14:14 2006
@@ -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.
- * <P><code>JDOImplHelper</code> allows construction of instances of persistence-capable
- * classes without using reflection.
+ * <P><code>JDOImplHelper</code> allows construction of instances of
+ * persistence-capable classes without using reflection.
* <P>Persistence-capable classes register themselves via a static method
* at class load time.
* There is no security restriction on this access. JDO implementations
@@ -67,17 +66,19 @@
/** This synchronized <code>HashMap</code> contains a static mapping of
* <code>PersistenceCapable</code> class to
* metadata for the class used for constructing new instances. New entries
- * are added by the static method in each <code>PersistenceCapable</code> class.
- * Entries are never removed.
+ * are added by the static method in each <code>PersistenceCapable</code>
+ * class. Entries are never removed.
*/
- private static Map registeredClasses = Collections.synchronizedMap(new HashMap ());
+ private static Map registeredClasses =
+ Collections.synchronizedMap(new HashMap ());
/** This Set contains all classes that have registered for setStateManager
* permissions via authorizeStateManagerClass.
*/
private static Map authorizedStateManagerClasses = new WeakHashMap();
- /** This list contains the registered listeners for <code>RegisterClassEvent</code>s.
+ /** This list contains the registered listeners for
+ * <code>RegisterClassEvent</code>s.
*/
private static List listeners = new ArrayList();
@@ -91,7 +92,8 @@
/** The Internationalization message helper.
*/
- private final static I18NHelper msg = I18NHelper.getInstance ("javax.jdo.Bundle"); //NOI18N
+ private final static I18NHelper msg =
+ I18NHelper.getInstance ("javax.jdo.Bundle"); //NOI18N
/** The DateFormat pattern.
*/
@@ -112,10 +114,12 @@
}
/** Get an instance of <code>JDOImplHelper</code>. This method
- * checks that the caller is authorized for <code>JDOPermission("getMetadata")</code>,
- * and if not, throws <code>SecurityException</code>.
+ * checks that the caller is authorized for
+ * <code>JDOPermission("getMetadata")</code>, and if not, throws
+ * <code>SecurityException</code>.
* @return an instance of <code>JDOImplHelper</code>.
- * @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 {
@@ -127,9 +131,9 @@
return jdoImplHelper;
}
- /** Get the field names for a <code>PersistenceCapable</code> class. The order
- * of fields is the natural ordering of the <code>String</code> class (without
- * considering localization).
+ /** Get the field names for a <code>PersistenceCapable</code> class. The
+ * order of fields is the natural ordering of the <code>String</code> class
+ * (without considering localization).
* @param pcClass the <code>PersistenceCapable</code> class.
* @return the field names for the class.
*/
@@ -138,8 +142,8 @@
return meta.getFieldNames();
}
- /** Get the field types for a <code>PersistenceCapable</code> class. The order
- * of fields is the same as for field names.
+ /** Get the field types for a <code>PersistenceCapable</code> class. The
+ * order of fields is the same as for field names.
* @param pcClass the <code>PersistenceCapable</code> class.
* @return the field types for the class.
*/
@@ -148,8 +152,8 @@
return meta.getFieldTypes();
}
- /** Get the field flags for a <code>PersistenceCapable</code> class. The order
- * of fields is the same as for field names.
+ /** Get the field flags for a <code>PersistenceCapable</code> class. The
+ * order of fields is the same as for field names.
* @param pcClass the <code>PersistenceCapable</code> class.
* @return the field types for the class.
*/
@@ -158,7 +162,8 @@
return meta.getFieldFlags();
}
- /** Get the persistence-capable superclass for a <code>PersistenceCapable</code> class.
+ /** Get the persistence-capable superclass for a
+ * <code>PersistenceCapable</code> class.
* @param pcClass the <code>PersistenceCapable</code> class.
* @return The <code>PersistenceCapable</code> superclass for this class,
* or <code>null</code> if there isn't one.
@@ -169,12 +174,14 @@
}
- /** Create a new instance of the class and assign its <code>jdoStateManager</code>.
- * The new instance has its <code>jdoFlags</code> set to <code>LOAD_REQUIRED</code>.
+ /** Create a new instance of the class and assign its
+ * <code>jdoStateManager</code>. The new instance has its
+ * <code>jdoFlags</code> set to <code>LOAD_REQUIRED</code>.
* @see PersistenceCapable#jdoNewInstance(StateManager sm)
* @param pcClass the <code>PersistenceCapable</code> class.
* @param sm the <code>StateManager</code> which will own the new instance.
- * @return the new instance, or <code>null</code> if the class is not registered.
+ * @return the new instance, or <code>null</code> if the class is not
+ * registered.
*/
public PersistenceCapable newInstance (Class pcClass, StateManager sm) {
Meta meta = getMeta (pcClass);
@@ -182,14 +189,16 @@
return pcInstance == null?null:pcInstance.jdoNewInstance(sm);
}
- /** Create a new instance of the class and assign its <code>jdoStateManager</code> and
- * key values from the ObjectId. If the oid parameter is <code>null</code>,
- * no key values are copied.
- * The new instance has its <code>jdoFlags</code> set to <code>LOAD_REQUIRED</code>.
+ /** Create a new instance of the class and assign its
+ * <code>jdoStateManager</code> and key values from the ObjectId. If the
+ * oid parameter is <code>null</code>, no key values are copied.
+ * The new instance has its <code>jdoFlags</code> set to
+ * <code>LOAD_REQUIRED</code>.
* @see PersistenceCapable#jdoNewInstance(StateManager sm, Object oid)
* @param pcClass the <code>PersistenceCapable</code> class.
* @param sm the <code>StateManager</code> which will own the new instance.
- * @return the new instance, or <code>null</code> if the class is not registered.
+ * @return the new instance, or <code>null</code> if the class is not
+ * registered.
* @param oid the ObjectId instance from which to copy key field values.
*/
public PersistenceCapable newInstance
@@ -251,8 +260,9 @@
/** Copy fields from an outside source to the key fields in the ObjectId.
* This method is generated in the <code>PersistenceCapable</code> class to
* generate a call to the field manager for each key field in the ObjectId.
- * <P>For example, an ObjectId class that has three key fields (<code>int id</code>,
- * <code>String name</code>, and <code>Float salary</code>) would have the method generated:
+ * <P>For example, an ObjectId class that has three key fields
+ * (<code>int id</code>, <code>String name</code>, and
+ * <code>Float salary</code>) would have the method generated:
* <P><code>
* void jdoCopyKeyFieldsToObjectId (Object oid, ObjectIdFieldSupplier fm) {
* <BR> oid.id = fm.fetchIntField (0);
@@ -260,7 +270,8 @@
* <BR> oid.salary = fm.fetchObjectField (2);
* <BR>}</code>
* <P>The implementation is responsible for implementing the
- * <code>ObjectIdFieldSupplier</code> to provide the values for the key fields.
+ * <code>ObjectIdFieldSupplier</code> to provide the values for the key
+ * fields.
* @param pcClass the <code>PersistenceCapable Class</code>.
* @param oid the ObjectId target of the copy.
* @param fm the field manager that supplies the field values.
@@ -270,17 +281,18 @@
Meta meta = getMeta (pcClass);
PersistenceCapable pcInstance = meta.getPC();
if (pcInstance == null) {
- throw new JDOFatalInternalException (
- msg.msg("ERR_AbstractClassNoIdentity", pcClass.getName())); //NOI18N
+ throw new JDOFatalInternalException (msg.msg(
+ "ERR_AbstractClassNoIdentity", pcClass.getName())); //NOI18N
}
pcInstance.jdoCopyKeyFieldsToObjectId(fm, oid);
}
/** Copy fields to an outside source from the key fields in the ObjectId.
- * This method is generated in the <code>PersistenceCapable</code> 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 (<code>int id</code>,
- * <code>String name</code>, and <code>Float salary</code>) would have the method generated:
+ * This method is generated in the <code>PersistenceCapable</code> 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
+ * (<code>int id</code>, <code>String name</code>, and
+ * <code>Float salary</code>) would have the method generated:
* <P><code>void jdoCopyKeyFieldsFromObjectId
* <BR> (PersistenceCapable oid, ObjectIdFieldConsumer fm) {
* <BR> fm.storeIntField (0, oid.id);
@@ -288,7 +300,8 @@
* <BR> fm.storeObjectField (2, oid.salary);
* <BR>}</code>
* <P>The implementation is responsible for implementing the
- * <code>ObjectIdFieldConsumer</code> to store the values for the key fields.
+ * <code>ObjectIdFieldConsumer</code> to store the values for the key
+ * fields.
* @param pcClass the <code>PersistenceCapable</code> class
* @param oid the ObjectId source of the copy.
* @param fm the field manager that receives the field values.
@@ -298,8 +311,8 @@
Meta meta = getMeta (pcClass);
PersistenceCapable pcInstance = meta.getPC();
if (pcInstance == null) {
- throw new JDOFatalInternalException (
- msg.msg("ERR_AbstractClassNoIdentity", pcClass.getName())); //NOI18N
+ throw new JDOFatalInternalException (msg.msg(
+ "ERR_AbstractClassNoIdentity", pcClass.getName())); //NOI18N
}
pcInstance.jdoCopyKeyFieldsFromObjectId(fm, oid);
}
@@ -311,11 +324,13 @@
*
* @param pcClass the <code>PersistenceCapable</code> class
* used as the key for lookup.
- * @param fieldNames an array of <code>String</code> field names for persistent and transactional fields
+ * @param fieldNames an array of <code>String</code> field names for
+ * persistent and transactional fields
* @param fieldTypes an array of <code>Class</code> field types
* @param fieldFlags the Field Flags for persistent and transactional fields
* @param pc an instance of the <code>PersistenceCapable</code> class
- * @param persistenceCapableSuperclass the most immediate superclass that is <code>PersistenceCapable</code>
+ * @param persistenceCapableSuperclass the most immediate superclass that is
+ * <code>PersistenceCapable</code>
*/
public static void registerClass (Class pcClass,
String[] fieldNames, Class[] fieldTypes,
@@ -360,7 +375,8 @@
sec.checkPermission (JDOPermission.MANAGE_METADATA);
}
synchronized(registeredClasses) {
- for (Iterator i = registeredClasses.keySet().iterator(); i.hasNext();) {
+ for (Iterator i = registeredClasses.keySet().iterator();
+ i.hasNext();) {
Class pcClass = (Class)i.next();
// Note, the pc class was registered by calling the static
// method JDOImplHelper.registerClass. This means the
@@ -382,7 +398,8 @@
* Unregister metadata by class. This method unregisters the specified
* class. Any further attempt to get metadata for the specified class will
* result in a <code>JDOFatalUserException</code>.
- * @param pcClass the <code>PersistenceCapable</code> class to be unregistered.
+ * @param pcClass the <code>PersistenceCapable</code> class to be
+ * unregistered.
* @since 1.0.2
*/
public void unregisterClass (Class pcClass)
@@ -398,7 +415,8 @@
}
/**
- * Add the specified <code>RegisterClassListener</code> to the listener list.
+ * Add the specified <code>RegisterClassListener</code> to the listener
+ * list.
* @param crl the listener to be added
*/
public void addRegisterClassListener (RegisterClassListener crl) {
@@ -406,14 +424,14 @@
synchronized (listeners) {
listeners.add(crl);
// Make a copy of the existing set of registered classes.
- // Between these two lines of code, any number of new class registrations
- // might occur, and will then all wait until this synchronized block completes.
- // Some of the class registrations might be delivered twice to
- // the newly registered listener.
+ // Between these two lines of code, any number of new class
+ // registrations might occur, and will then all wait until this
+ // synchronized block completes. Some of the class registrations
+ // might be delivered twice to the newly registered listener.
alreadyRegisteredClasses = new HashSet (registeredClasses.keySet());
}
- // new registrations will call the new listener while the following occurs
- // notify the new listener about already-registered classes
+ // new registrations will call the new listener while the following
+ // occurs notify the new listener about already-registered classes
for (Iterator it = alreadyRegisteredClasses.iterator(); it.hasNext();) {
Class pcClass = (Class)it.next();
Meta meta = getMeta (pcClass);
@@ -425,7 +443,8 @@
}
/**
- * Remove the specified <code>RegisterClassListener</code> from the listener list.
+ * Remove the specified <code>RegisterClassListener</code> from the listener
+ * list.
* @param crl the listener to be removed
*/
public void removeRegisterClassListener (RegisterClassListener crl) {
@@ -461,8 +480,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 smClass a Class that is authorized for JDOPermission("setStateManager").
- * @throws SecurityException if the caller is not authorized for JDOPermission("setStateManager").
+ * @param smClass a Class that is 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,12 +504,14 @@
* 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)
- throws SecurityException {
+ public static void registerAuthorizedStateManagerClasses (
+ Collection smClasses) throws SecurityException {
SecurityManager sm = System.getSecurityManager();
if (sm != null) {
sm.checkPermission(JDOPermission.SET_STATE_MANAGER);
@@ -588,16 +611,19 @@
static {
JDOImplHelper helper = getInstance();
if (isClassLoadable("java.util.Currency")) {
- helper.registerStringConstructor(Currency.class, new StringConstructor() {
+ helper.registerStringConstructor(
+ Currency.class, new StringConstructor() {
public Object construct(String s) {
try {
return Currency.getInstance(s);
} catch (IllegalArgumentException ex) {
- throw new javax.jdo.JDOUserException(
- msg.msg("EXC_CurrencyStringConstructorIllegalArgument", s), ex); //NOI18N
+ throw new javax.jdo.JDOUserException(msg.msg(
+ "EXC_CurrencyStringConstructorIllegalArgument", //NOI18N
+ s), ex);
} catch (Exception ex) {
- throw new JDOUserException(
- msg.msg("EXC_CurrencyStringConstructorException"), ex); //NOI18N
+ throw new JDOUserException(msg.msg(
+ "EXC_CurrencyStringConstructorException"), //NOI18N
+ ex);
}
}
});
@@ -607,8 +633,8 @@
try {
return getLocale(s);
} catch (Exception ex) {
- throw new JDOUserException(
- msg.msg("EXC_LocaleStringConstructorException"), ex); //NOI18N
+ throw new JDOUserException(msg.msg(
+ "EXC_LocaleStringConstructorException"), ex); //NOI18N
}
}
});
@@ -622,9 +648,10 @@
ParsePosition pp = new ParsePosition(0);
Date result = dateFormat.parse(s, pp);
if (result == null) {
- throw new JDOUserException (
- msg.msg("EXC_DateStringConstructor", new Object[] //NOI18N
- {s, new Integer(pp.getErrorIndex()), dateFormatPattern}));
+ throw new JDOUserException (msg.msg(
+ "EXC_DateStringConstructor", new Object[] //NOI18N
+ {s, new Integer(pp.getErrorIndex()),
+ dateFormatPattern}));
}
return result;
}
@@ -735,7 +762,8 @@
* @param fieldNames An array of <code>String</code>
* @param fieldTypes An array of <code>Class</code>
* @param fieldFlags an array of <code>int</code>
- * @param persistenceCapableSuperclass the most immediate <code>PersistenceCapable</code> superclass
+ * @param persistenceCapableSuperclass the most immediate
+ * <code>PersistenceCapable</code> superclass
* @param pc An instance of the <code>PersistenceCapable</code> class
*/
Meta (String[] fieldNames, Class[] fieldTypes, byte[] fieldFlags,
@@ -751,7 +779,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 +792,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 +805,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 +814,8 @@
return fieldFlags;
}
- /** This is the <code>Class</code> instance of the <code>PersistenceCapable</code> superclass.
+ /** This is the <code>Class</code> instance of the
+ * <code>PersistenceCapable</code> superclass.
*/
Class persistenceCapableSuperclass;
Modified: db/jdo/trunk/api20/src/java/javax/jdo/spi/JDOPermission.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/spi/JDOPermission.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/spi/JDOPermission.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/spi/JDOPermission.java Tue Mar 28 14:14:14 2006
@@ -17,8 +17,8 @@
package javax.jdo.spi;
/**
- * The <code>JDOPermission</code> class is for operations that are reserved for JDO
- * implementations and should not be called by other code. A
+ * The <code>JDOPermission</code> class is for operations that are reserved for
+ * JDO implementations and should not be called by other code. A
* <code>JDOPermission</code> is a <em>named permission</em> 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 @@
*
* <tr>
* <td><code>setStateManager</code></td>
- * <td>This allows setting the <code>StateManager</code> for an instance of <code>PersistenceCapable</code>.
- * The <code>StateManager</code>
+ * <td>This allows setting the <code>StateManager</code> for an instance of
+ * <code>PersistenceCapable</code>. The <code>StateManager</code>
* has unlimited access to get and set persistent and transactional fields of
* the <code>PersistenceCapable</code> instance.</td>
* <td>This is dangerous in that information (possibly confidential)
@@ -48,18 +48,19 @@
*
* <tr>
* <td><code>getMetadata</code></td>
- * <td>This allows getting metadata for any <code>PersistenceCapable</code> class that has
- * registered with <code>JDOImplHelper</code>.</td>
+ * <td>This allows getting metadata for any <code>PersistenceCapable</code>
+ * class that has registered with <code>JDOImplHelper</code>.</td>
* <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> class that has
- * registered with <code>JDOImplHelper</code>.</td>
+ * <td>This allows managing metadata for any <code>PersistenceCapable</code>
+ * class that has registered with <code>JDOImplHelper</code>.</td>
* <td>This is dangerous in that metadata information (possibly confidential)
- * normally unavailable would be manageable (modifiable) by malicious code.</td>
+ * normally unavailable would be manageable (modifiable) by malicious code.
+ * </td>
* </tr>
*
* <tr>
@@ -92,9 +93,9 @@
}
/**
- * Constructs a <code>JDOPermission</code> with the specified name and actions.
- * The actions should be <code>null</code>; they are ignored. This
- * constructor exists for use by the <code>Policy</code> object
+ * Constructs a <code>JDOPermission</code> with the specified name and
+ * actions. The actions should be <code>null</code>; they are ignored.
+ * This constructor exists for use by the <code>Policy</code> object
* to instantiate new <code>Permission</code> objects.
*
* @param name the name of the <code>JDOPermission</code>
Modified: db/jdo/trunk/api20/src/java/javax/jdo/spi/PersistenceCapable.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/spi/PersistenceCapable.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/spi/PersistenceCapable.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/spi/PersistenceCapable.java Tue Mar 28 14:14:14 2006
@@ -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 @@
*
*<P>Transient instances return false.
*<P>
- * @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 @@
*
*<P>Transient instances return false.
*<P>
- * @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 @@
*
*<P>Transient instances return false.
*<P>
- * @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 @@
*
*<P>Transient instances return false.
*<P>
- * @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 @@
*
*<P>Transient instances return false.
*<P>
- * @see JDOHelper#isDetached(Object pc)
+ * @see javax.jdo.JDOHelper#isDetached(Object pc)
* @return true if this instance is detached.
* @since 2.0
*/
Modified: db/jdo/trunk/api20/src/java/javax/jdo/spi/StateInterrogation.java
URL: http://svn.apache.org/viewcvs/db/jdo/trunk/api20/src/java/javax/jdo/spi/StateInterrogation.java?rev=389615&r1=389614&r2=389615&view=diff
==============================================================================
--- db/jdo/trunk/api20/src/java/javax/jdo/spi/StateInterrogation.java (original)
+++ db/jdo/trunk/api20/src/java/javax/jdo/spi/StateInterrogation.java Tue Mar 28 14:14:14 2006
@@ -174,7 +174,7 @@
* @return the <code>PersistenceManager</code> 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, <code>PersistenceCapable</code> 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
+}