266912: Update javax.persistence.metamodel API javadoc comments in sync with 20090702 jar
https://bugs.eclipse.org/bugs/attachment.cgi?id=141134&action=diff
diff --git a/src/javax/persistence/metamodel/Attribute.java b/src/javax/persistence/metamodel/Attribute.java
index 9bd4d29..bcba2ef 100644
--- a/src/javax/persistence/metamodel/Attribute.java
+++ b/src/javax/persistence/metamodel/Attribute.java
@@ -45,8 +45,8 @@
String getName();
/**
- * Return the multiplicity of the attribute.
- * @return multiplicity
+ * Return the persistent attribute type for the attribute.
+ * @return persistent attribute type
*/
PersistentAttributeType getPersistentAttributeType();
@@ -72,13 +72,15 @@
/**
* Is the attribute an association.
- * @return whether an association
+ * @return whether boolean indicating whether attribute
+ * corresponds to an association
*/
boolean isAssociation();
/**
* Is the attribute collection-valued.
- * @return whether a collection
+ * @return boolean indicating whether attribute is
+ * collection-valued
*/
boolean isCollection();
diff --git a/src/javax/persistence/metamodel/IdentifiableType.java b/src/javax/persistence/metamodel/IdentifiableType.java
index 891d17d..6f1fbba 100644
--- a/src/javax/persistence/metamodel/IdentifiableType.java
+++ b/src/javax/persistence/metamodel/IdentifiableType.java
@@ -50,18 +50,18 @@
* @param type the type of the represented version attribute
* @return version attribute
* @throws IllegalArgumentException if version attribute of the
- * given type is not present in the identifiable type
+ * given type is not present in the identifiable type
*/
<Y> SingularAttribute<? super X, Y> getVersion(Class<Y> type);
/**
* Return the attribute that corresponds to the id attribute
* declared by the entity or mapped superclass.
- * @param type the type of the represented declared id
- * attribute
+ * @param type the type of the represented declared id attribute
* @return declared id attribute
* @throws IllegalArgumentException if id attribute of the given
- * type is not present in the identifiable type
+ * type is not declared in the identifiable type or if
+ * the identifiable type has an id class
*/
<Y> SingularAttribute<X, Y> getDeclaredId(Class<Y> type);
@@ -72,15 +72,15 @@
* attribute
* @return declared version attribute
* @throws IllegalArgumentException if version attribute of the
- * type is not present in the identifiable type
+ * type is not declared in the identifiable type
*/
<Y> SingularAttribute<X, Y> getDeclaredVersion(Class<Y> type);
/**
* Return the identifiable type that corresponds to the most
* specific mapped superclass or entity extended by the entity
- * or mapped superclass.
- * @return supertype of identifiable type
+ * or mapped superclass.
+ * @return supertype of identifiable type or null if no such supertype
*/
IdentifiableType<? super X> getSupertype();
diff --git a/src/javax/persistence/metamodel/SingularAttribute.java b/src/javax/persistence/metamodel/SingularAttribute.java
index e617051..335fc6b 100644
--- a/src/javax/persistence/metamodel/SingularAttribute.java
+++ b/src/javax/persistence/metamodel/SingularAttribute.java
@@ -37,20 +37,21 @@
/**
* Is the attribute an id attribute.
- * @return boolean indicating whether or not an id
+ * @return boolean indicating whether or not attribute is an id
*/
boolean isId();
/**
* Is the attribute a version attribute.
- * @return boolean indicating whether or not a version attribute
+ * @return boolean indicating whether or not attribute is
+ * a version attribute
*/
boolean isVersion();
/**
* Can the attribute be null.
* @return boolean indicating whether or not the attribute can
- * be null
+ * be null
*/
boolean isOptional();
