Skip to content

Commit 9902bc1

Browse files
committed
CAUSEWAY-4036: ValueSemantics java-doc
1 parent 2fe8dc0 commit 9902bc1

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

api/applib/src/main/java/org/apache/causeway/applib/annotation/ValueSemantics.java

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ String provider()
7979
* no longer viable.
8080
*
8181
* <p> When {@link Column#precision()} {@code >0} is used,
82-
* while {@link ValueSemantics} is not used,
82+
* while {@link ValueSemantics#maxTotalDigits()} is not used (<=0),
8383
* then {@link Column#precision()} is undersood as an alias for this annotation attribute.
8484
*
8585
* <p> default = {@code 0} understood as unlimited
@@ -100,7 +100,11 @@ int maxTotalDigits()
100100
* Those types may support scientific notation for input (as well as display), where the notion of 'integer digits'
101101
* is still viable.
102102
*
103+
* <p> {@link Digits#integer()} can be used as a replacement. If both are used, the stronger constraint applies.
104+
*
103105
* <p> default = {@code 0} understood as unlimited
106+
*
107+
* @see Digits#integer()
104108
*/
105109
int maxIntegerDigits()
106110
default 0;
@@ -131,13 +135,16 @@ int minIntegerDigits()
131135
* types have fixed intrinsic precision and their bit representation does not
132136
* directly correspond to decimal digits.
133137
*
138+
* <p> {@link Digits#fraction()} can be used as a replacement. If both are used, the stronger constraint applies.
139+
*
134140
* <p> When {@link Column#scale()} {@code >0} is used on a {@link BigDecimal},
135-
* while {@link ValueSemantics} is not used,
141+
* while {@link ValueSemantics#maxFractionalDigits()} is not used (<0),
136142
* then {@link Column#scale()} is undersood as an alias for this annotation attribute.
137143
*
138144
* <p> default = {@code -1} understood as unlimited
139145
*
140146
* @apiNote SQL's DECIMAL(precision, scale) has max-precision=65 and max-scale=30
147+
* @see Digits#fraction()
141148
* @see Column#scale()
142149
*/
143150
int maxFractionalDigits()

0 commit comments

Comments
 (0)