db-jdo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From c..@apache.org
Subject svn commit: r561068 - /db/jdo/trunk/api2/src/java/javax/jdo/annotations/
Date Mon, 30 Jul 2007 17:55:30 GMT
Author: clr
Date: Mon Jul 30 10:55:27 2007
New Revision: 561068

URL: http://svn.apache.org/viewvc?view=rev&rev=561068
Log:
JDO-403 Javadoc updates for annotations.

Modified:
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Column.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/DatastoreIdentity.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Discriminator.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/DiscriminatorStrategy.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Element.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Embedded.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Extension.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/FetchGroup.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/ForeignKey.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/ForeignKeyAction.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/IdGeneratorStrategy.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/IdentityType.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Implements.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Index.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Inheritance.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/InheritanceStrategy.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Join.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Key.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/NotPersistent.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/NullValue.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Order.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/PersistenceAware.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/PersistenceModifier.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Persistent.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/PrimaryKey.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Query.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/QueryLanguage.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/SequenceStrategy.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Serialized.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Transactional.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Unique.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Value.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/Version.java
    db/jdo/trunk/api2/src/java/javax/jdo/annotations/VersionStrategy.java

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Column.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Column.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Column.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Column.java Mon Jul 30 10:55:27 2007
@@ -23,7 +23,7 @@
 
 /**
  * Annotation for a column in the database.
- * Maps to the xml element "column".
+ * Corresponds to the xml element "column".
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/DatastoreIdentity.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/DatastoreIdentity.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/DatastoreIdentity.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/DatastoreIdentity.java Mon Jul 30 10:55:27
2007
@@ -23,7 +23,7 @@
 
 /**
  * Annotation for the datastore identity of the class.
- * Maps across to the JDO2 element "datastore-identity" of the "class" element.
+ * Corresponds to the xml element "datastore-identity" of the "class" element.
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Discriminator.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Discriminator.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Discriminator.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Discriminator.java Mon Jul 30 10:55:27
2007
@@ -23,7 +23,7 @@
 
 /**
  * Annotation for the discriminator of the class.
- * Maps across to the JDO2 element "discriminator" of the "inheritance" element.
+ * Corresponds to the xml element "discriminator" of the "inheritance" element.
  * 
  * @version 2.1
  * @since 2.1
@@ -33,9 +33,9 @@
 public @interface Discriminator
 {
     /**
-     * Strategy to use for discriminator. The discriminator determines
+     * Strategy to use for the discriminator. The discriminator determines
      * the class associated with a row in the datastore.
-     * @return the strategy to use for discriminator
+     * @return the strategy to use for the discriminator
      */
     DiscriminatorStrategy strategy() 
         default DiscriminatorStrategy.UNKNOWN;

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/DiscriminatorStrategy.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/DiscriminatorStrategy.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/DiscriminatorStrategy.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/DiscriminatorStrategy.java Mon Jul 30
10:55:27 2007
@@ -17,7 +17,7 @@
 package javax.jdo.annotations;
 
 /**
- * Enumeration of the JDO2 discriminator strategy values.
+ * Enumeration of the discriminator strategy values.
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Element.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Element.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Element.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Element.java Mon Jul 30 10:55:27 2007
@@ -24,7 +24,7 @@
 
 /**
  * Annotation for the element of a collection/array relation.
- * Maps to the xml element "element".
+ * Corresponds to the xml element "element".
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Embedded.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Embedded.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Embedded.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Embedded.java Mon Jul 30 10:55:27 2007
@@ -24,7 +24,7 @@
 /**
  * Annotation to define that the object is embedded into the table of the 
  * owning object.
- * Maps to the xml element "embedded".
+ * Corresponds to the xml element "embedded".
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Extension.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Extension.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Extension.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Extension.java Mon Jul 30 10:55:27 2007
@@ -22,8 +22,8 @@
 import java.lang.annotation.Target;
 
 /**
- * Annotation for a JDO extension.
- * Maps across to the JDO2 element "extension".
+ * Annotation for a JDO vendor extension.
+ * Corresponds to the xml element "extension".
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/FetchGroup.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/FetchGroup.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/FetchGroup.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/FetchGroup.java Mon Jul 30 10:55:27 2007
@@ -23,7 +23,7 @@
 
 /**
  * Annotation for the fetch group of a class.
- * Maps to the xml element "fetch-group".
+ * Corresponds to the xml element "fetch-group".
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/ForeignKey.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/ForeignKey.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/ForeignKey.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/ForeignKey.java Mon Jul 30 10:55:27 2007
@@ -23,7 +23,7 @@
 
 /**
  * Annotation for a database foreign-key.
- * Maps to the xml element "foreign-key".
+ * Corresponds to the xml element "foreign-key".
  *
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/ForeignKeyAction.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/ForeignKeyAction.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/ForeignKeyAction.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/ForeignKeyAction.java Mon Jul 30 10:55:27
2007
@@ -17,7 +17,7 @@
 package javax.jdo.annotations;
 
 /**
- * Enumeration of the JDO2 foreign-key delete/update action values.
+ * Enumeration of the foreign-key delete/update action values.
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/IdGeneratorStrategy.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/IdGeneratorStrategy.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/IdGeneratorStrategy.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/IdGeneratorStrategy.java Mon Jul 30 10:55:27
2007
@@ -17,7 +17,7 @@
 package javax.jdo.annotations;
 
 /**
- * Enumeration of the JDO2 id generator strategy values.
+ * Enumeration of the id generator strategy values.
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/IdentityType.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/IdentityType.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/IdentityType.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/IdentityType.java Mon Jul 30 10:55:27
2007
@@ -17,7 +17,7 @@
 package javax.jdo.annotations;
 
 /**
- * Enumeration of the JDO2 identity type values.
+ * Enumeration of the identity type values.
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Implements.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Implements.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Implements.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Implements.java Mon Jul 30 10:55:27 2007
@@ -23,7 +23,7 @@
 
 /**
  * Annotation for the interfaces implemented by a class.
- * Maps across to the JDO2 element "implements".
+ * Corresponds to the xml element "implements".
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Index.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Index.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Index.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Index.java Mon Jul 30 10:55:27 2007
@@ -24,7 +24,7 @@
 /**
  * Annotation for a database index. Used for database schema
  * generation to create indexes.
- * Maps to the xml element "index".
+ * Corresponds to the xml element "index".
  *
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Inheritance.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Inheritance.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Inheritance.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Inheritance.java Mon Jul 30 10:55:27
2007
@@ -23,7 +23,8 @@
 
 /**
  * Annotation for the inheritance of the class.
- * Maps across to the JDO2 element "inheritance" of the "class" element.
+ * Corresponds to the xml element "inheritance" of the "class"
+ * and "interface" elements.
  * 
  * @version 2.1
  * @since 2.1
@@ -32,8 +33,8 @@
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Inheritance
 {
-    /** Strategy to use for inheritance. Specifies where the data for
-     * the class is stored.
+    /** Strategy to use for inheritance. Specifies in which table(s)
+     * the members for the class are stored. 
      * @return the inheritance strategy
      */
     InheritanceStrategy strategy();

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/InheritanceStrategy.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/InheritanceStrategy.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/InheritanceStrategy.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/InheritanceStrategy.java Mon Jul 30 10:55:27
2007
@@ -17,7 +17,7 @@
 package javax.jdo.annotations;
 
 /**
- * Enumeration of the JDO2 inheritance strategy values.
+ * Enumeration of the inheritance strategy values.
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Join.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Join.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Join.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Join.java Mon Jul 30 10:55:27 2007
@@ -23,7 +23,7 @@
 
 /**
  * Annotation for the join of a relation.
- * Maps to the xml element "join".
+ * Corresponds to the xml element "join".
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Key.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Key.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Key.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Key.java Mon Jul 30 10:55:27 2007
@@ -24,7 +24,7 @@
 
 /**
  * Annotation for the key of a map relation.
- * Maps to the xml element "key".
+ * Corresponds to the xml element "key".
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/NotPersistent.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/NotPersistent.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/NotPersistent.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/NotPersistent.java Mon Jul 30 10:55:27
2007
@@ -22,8 +22,10 @@
 import java.lang.annotation.Target;
 
 /**
- * Annotation for whether the member is not persistent.
- * This maps to xml attribute persistence-modifier="none".
+ * Annotation to specify that the member is not persistent. If used, this is
+ * the only JDO annotation allowed on a member.
+ * This corresponds to the xml attribute persistence-modifier="none" of the
+ * "field" and "property" elements.
  * @version 2.1
  * @since 2.1
  */

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/NullValue.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/NullValue.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/NullValue.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/NullValue.java Mon Jul 30 10:55:27 2007
@@ -17,8 +17,10 @@
 package javax.jdo.annotations;
 
 /**
- * Enumeration of the JDO2 "null-value" behavior values.
- * 
+ * Enumeration of the "null-value" behavior values.
+ * This corresponds to the "null-value" attribute of the "field"
+ * and "property" elements.
+ *
  * @version 2.1
  * @since 2.1
  */

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Order.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Order.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Order.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Order.java Mon Jul 30 10:55:27 2007
@@ -22,8 +22,10 @@
 import java.lang.annotation.Target;
 
 /**
- * Annotation for the order of a container member.
- * Maps to the xml element "order".
+ * Annotation for the ordering component of an ordered container member, 
+ * such as Java Collections Framework Array and List types and Java native
+ * array types.
+ * Corresponds to the xml element "order".
  * 
  * @version 2.1
  * @since 2.1
@@ -32,14 +34,13 @@
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Order
 {
-    /** The name of the column to use for the ordering column (1-N and M-N
-     * relations).
+    /** The name of the column to use for ordering the elements of the member.
      * @return the name of the ordering column
      */
     String column() default "";
 
     /** Name of a field or property in the target class that acts as the 
-     * ordering field or property for this Collection/List/Array.
+     * ordering field or property for this member.
      * Return the name of the field or property in the target class
      */
     String mappedBy() default "";

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/PersistenceAware.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/PersistenceAware.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/PersistenceAware.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/PersistenceAware.java Mon Jul 30 10:55:27
2007
@@ -22,8 +22,10 @@
 import java.lang.annotation.Target;
 
 /**
- * Annotation for whether the class is persistence-aware.
- * 
+ * Annotation to specify that the class is persistence-aware. If used, this is
+ * the only JDO annotation allowed on the class.
+ * This corresponds to the xml attribute 
+ * persistence-modifier="persistence-aware" of the "class" element.
  * @version 2.1
  * @since 2.1
  */

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/PersistenceModifier.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/PersistenceModifier.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/PersistenceModifier.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/PersistenceModifier.java Mon Jul 30 10:55:27
2007
@@ -17,7 +17,9 @@
 package javax.jdo.annotations;
 
 /**
- * Enumeration of the JDO2 persistence-modifier values for a field.
+ * Enumeration of the persistence-modifier values for a field or property.
+ * This corresponds to the "persistence-modifier" attribute of the
+ * "field" and "property" elements.
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Persistent.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Persistent.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Persistent.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Persistent.java Mon Jul 30 10:55:27 2007
@@ -22,7 +22,8 @@
 import java.lang.annotation.Target;
 
 /**
- * Annotation for defining the persistence of a member (field or property).
+ * Annotation for defining the persistence of a member.
+ * This corresponds to the xml elements "field" and "property". 
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/PrimaryKey.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/PrimaryKey.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/PrimaryKey.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/PrimaryKey.java Mon Jul 30 10:55:27 2007
@@ -25,7 +25,7 @@
  * Annotation on a member to define it as a primary key member of a class or
  * persistent interface using application identity. 
  * Also used to define the primary key columns of a secondary table.
- * Maps to the xml element "primary-key".
+ * Corresponds to the xml element "primary-key".
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Query.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Query.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Query.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Query.java Mon Jul 30 10:55:27 2007
@@ -23,7 +23,7 @@
 
 /**
  * Annotation for a named query.
- * Maps across to the JDO2 element "query".
+ * Corresponds to the xml element "query".
  * 
  * @version 2.1
  * @since 2.1
@@ -57,7 +57,7 @@
      */
     String unique() default "";
 
-    /** Result class to put the results into
+    /** Result class into which to put the results.
      * @return the class of the result
      */
     Class resultClass() default void.class;

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/QueryLanguage.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/QueryLanguage.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/QueryLanguage.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/QueryLanguage.java Mon Jul 30 10:55:27
2007
@@ -17,7 +17,7 @@
 package javax.jdo.annotations;
 
 /**
- * Enumeration of the JDO2 query languages.
+ * Enumeration of the query language.
  * 
  * @version 2.1
  * @since 2.1
@@ -26,5 +26,4 @@
 {
     JDOQL,
     SQL
-    // Allow for implementations own languages ... e.g add CUSTOM as an option
 };

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/SequenceStrategy.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/SequenceStrategy.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/SequenceStrategy.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/SequenceStrategy.java Mon Jul 30 10:55:27
2007
@@ -17,7 +17,7 @@
 package javax.jdo.annotations;
 
 /**
- * Enumeration of the JDO2 sequence strategy values.
+ * Enumeration of the sequence strategy values.
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Serialized.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Serialized.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Serialized.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Serialized.java Mon Jul 30 10:55:27 2007
@@ -23,7 +23,10 @@
 
 /**
  * Annotation on a member (field or property) to indicate that
- * the member is stored serialized.
+ * the member is stored serialized. Such a member cannot be queried using
+ * JDOQL.
+ * Corresponds to xml attribute "serialized" in "field" and "property" 
+ * elements.
  * This is the same as specifying @Persistent(serialized="true").
  * 
  * @version 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Transactional.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Transactional.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Transactional.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Transactional.java Mon Jul 30 10:55:27
2007
@@ -24,7 +24,8 @@
 /**
  * Annotation to indicate that a member (field or property)
  * is transactional but not persistent.
- * This maps to xml attribute persistence-modifier="transactional".
+ * This corresponds to xml attribute persistence-modifier="transactional" of
+ * "field" and "property" elements.
  * @version 2.1
  * @since 2.1
  */

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Unique.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Unique.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Unique.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Unique.java Mon Jul 30 10:55:27 2007
@@ -25,7 +25,7 @@
  * Annotation for a database unique constraint. Used for database schema
  * generation to create unique constraints. Also used to reorder database
  * operations when flushing changes to avoid unique constraint violations.
- * Maps across to the JDO2 element "unique".
+ * Corresponds to the xml element "unique".
  *
  * @version 2.1
  * @since 2.1
@@ -40,8 +40,8 @@
     String name() default "";
 
     /** Table for the unique constraint. This is needed iff annotating a type 
-     * where the unique constraint is not defined on the primary table for 
-     * the type.
+     * where this unique constraint is not for the primary table for 
+     * the persistent class or interface.
      * @return the table on which the unique constraint is defined
      */
     String table() default "";

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Value.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Value.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Value.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Value.java Mon Jul 30 10:55:27 2007
@@ -23,7 +23,7 @@
 
 /**
  * Annotation for the value of a map relation.
- * Maps across to the JDO2 element "value".
+ * Corresponds to the xml element "value".
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/Version.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/Version.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/Version.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/Version.java Mon Jul 30 10:55:27 2007
@@ -23,7 +23,8 @@
 
 /**
  * Annotation for the versioning of the class.
- * Maps across to the JDO2 element "version" of the "class" element.
+ * Corresponds to the xml element "version" of the "class" and "property" 
+ * elements.
  * 
  * @version 2.1
  * @since 2.1

Modified: db/jdo/trunk/api2/src/java/javax/jdo/annotations/VersionStrategy.java
URL: http://svn.apache.org/viewvc/db/jdo/trunk/api2/src/java/javax/jdo/annotations/VersionStrategy.java?view=diff&rev=561068&r1=561067&r2=561068
==============================================================================
--- db/jdo/trunk/api2/src/java/javax/jdo/annotations/VersionStrategy.java (original)
+++ db/jdo/trunk/api2/src/java/javax/jdo/annotations/VersionStrategy.java Mon Jul 30 10:55:27
2007
@@ -17,7 +17,7 @@
 package javax.jdo.annotations;
 
 /**
- * Enumeration of the JDO2 version strategy values.
+ * Enumeration of the version strategy values.
  * 
  * @version 2.1
  * @since 2.1



Mime
View raw message