clarify the semantics of Bindable.ENTITY_TYPE via javadoc

see jakartaee#106
gavinking · Aug 15, 2023 · 96b5613 · 96b5613
1 parent 5604d11
commit 96b5613
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 15 deletions.
diff --git a/api/src/main/java/jakarta/persistence/metamodel/Bindable.java b/api/src/main/java/jakarta/persistence/metamodel/Bindable.java
@@ -28,25 +28,36 @@
  *
  */
 public interface Bindable<T> {
-
-	public static enum BindableType { 
+
+    public static enum BindableType {
+        /**
+         * Single-valued attribute type.
+         *
+         * @see SingularAttribute
+         */
+        SINGULAR_ATTRIBUTE, 
 
-	    /** Single-valued attribute type */
-	    SINGULAR_ATTRIBUTE, 
+        /**
+         * Multivalued attribute type, that is, a collection.
+         *
+         * @see PluralAttribute
+         */
+        PLURAL_ATTRIBUTE, 
 
-	    /** Multi-valued attribute type */
-	    PLURAL_ATTRIBUTE, 
-
-	    /** Entity type */
-	    ENTITY_TYPE
-	}
+        /**
+         * Entity type.
+         *
+         * @see EntityType
+         */
+        ENTITY_TYPE
+    }
 
     /**
      *  Return the bindable type of the represented object.
      *  @return bindable type
      */	
     BindableType getBindableType();
-	
+
     /**
      * Return the Java type of the represented object.
      * If the bindable type of the object is <code>PLURAL_ATTRIBUTE</code>,

diff --git a/spec/src/main/asciidoc/ch05-metamodel-api.adoc b/spec/src/main/asciidoc/ch05-metamodel-api.adoc
@@ -660,14 +660,25 @@ import jakarta.persistence.criteria.Path;
 public interface Bindable<T> {
 
     public static enum BindableType {
-
-        /** Single-valued attribute type */
+        /**
+         * Single-valued attribute type.
+         *
+         * @see SingularAttribute
+         */
         SINGULAR_ATTRIBUTE,
 
-        /** Multi-valued attribute type */
+        /**
+         * Multivalued attribute type, that is, a collection.
+         *
+         * @see PluralAttribute
+         */
         PLURAL_ATTRIBUTE,
 
-        /** Entity type */
+        /**
+         * Entity type.
+         *
+         * @see EntityType
+         */
         ENTITY_TYPE
     }