cayenne-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ntimof...@apache.org
Subject [cayenne] branch master updated: Missing JavaDocs for property API
Date Wed, 04 Sep 2019 15:17:14 GMT
This is an automated email from the ASF dual-hosted git repository.

ntimofeev pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cayenne.git


The following commit(s) were added to refs/heads/master by this push:
     new 4562b57  Missing JavaDocs for property API
4562b57 is described below

commit 4562b57a2a019a2288dca2f25f15173735a46191
Author: Nikita Timofeev <stariy95@gmail.com>
AuthorDate: Wed Sep 4 18:17:07 2019 +0300

    Missing JavaDocs for property API
---
 .../main/java/org/apache/cayenne/exp/property/BaseIdProperty.java   | 2 ++
 .../src/main/java/org/apache/cayenne/exp/property/IdProperty.java   | 1 +
 .../java/org/apache/cayenne/exp/property/NumericIdProperty.java     | 2 ++
 .../src/main/java/org/apache/cayenne/exp/property/package-info.java | 6 ++++++
 4 files changed, 11 insertions(+)

diff --git a/cayenne-server/src/main/java/org/apache/cayenne/exp/property/BaseIdProperty.java
b/cayenne-server/src/main/java/org/apache/cayenne/exp/property/BaseIdProperty.java
index 44cff17..5283a47 100644
--- a/cayenne-server/src/main/java/org/apache/cayenne/exp/property/BaseIdProperty.java
+++ b/cayenne-server/src/main/java/org/apache/cayenne/exp/property/BaseIdProperty.java
@@ -24,6 +24,8 @@ import java.util.Objects;
 import org.apache.cayenne.exp.ExpressionFactory;
 
 /**
+ * Property that represents non-numeric PK
+ *
  * @since 4.2
  */
 public class BaseIdProperty<E> extends BaseProperty<E> implements IdProperty<E>
{
diff --git a/cayenne-server/src/main/java/org/apache/cayenne/exp/property/IdProperty.java
b/cayenne-server/src/main/java/org/apache/cayenne/exp/property/IdProperty.java
index 6f6e528..c2f72f1 100644
--- a/cayenne-server/src/main/java/org/apache/cayenne/exp/property/IdProperty.java
+++ b/cayenne-server/src/main/java/org/apache/cayenne/exp/property/IdProperty.java
@@ -27,6 +27,7 @@ import org.apache.cayenne.exp.Expression;
 import org.apache.cayenne.exp.ExpressionFactory;
 
 /**
+ * Base class for properties mapped to PK
  * @since 4.2
  */
 public interface IdProperty<E> extends Property<E> {
diff --git a/cayenne-server/src/main/java/org/apache/cayenne/exp/property/NumericIdProperty.java
b/cayenne-server/src/main/java/org/apache/cayenne/exp/property/NumericIdProperty.java
index 83c98c4..75be799 100644
--- a/cayenne-server/src/main/java/org/apache/cayenne/exp/property/NumericIdProperty.java
+++ b/cayenne-server/src/main/java/org/apache/cayenne/exp/property/NumericIdProperty.java
@@ -24,6 +24,8 @@ import java.util.Objects;
 import org.apache.cayenne.exp.ExpressionFactory;
 
 /**
+ * Property that represents numeric PK
+ *
  * @since 4.2
  */
 public class NumericIdProperty<E extends Number> extends NumericProperty<E> implements
IdProperty<E> {
diff --git a/cayenne-server/src/main/java/org/apache/cayenne/exp/property/package-info.java
b/cayenne-server/src/main/java/org/apache/cayenne/exp/property/package-info.java
index 23bd13f..5b23d5f 100644
--- a/cayenne-server/src/main/java/org/apache/cayenne/exp/property/package-info.java
+++ b/cayenne-server/src/main/java/org/apache/cayenne/exp/property/package-info.java
@@ -57,6 +57,12 @@
  *     In addition to to-one related methods these properties support collection comparision
methods
  *     like {@link org.apache.cayenne.exp.property.ListProperty#contains(org.apache.cayenne.Persistent)
contains()}.
  *     <br>
+ *     <li>{@link org.apache.cayenne.exp.property.EmbeddableProperty} for embeddable
objects
+ *     <br>
+ *     <li>{@link org.apache.cayenne.exp.property.NumericIdProperty} for numeric PK
properties
+ *     <br>
+ *     <li>{@link org.apache.cayenne.exp.property.BaseIdProperty} for non-numeric PK
properties
+ *     <br>
  *     <li>{@link org.apache.cayenne.exp.property.BaseProperty} for all other data
types, supports basic operations (equality, sorting).
  * </ul>
  *


Mime
View raw message