improve javadoc of @byte* more kindly #761

terasolunaorg · Oct 15, 2017 · b7b43c4 · b7b43c4
1 parent 3873d99
commit b7b43c4
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/...-gfw-validator/src/main/java/org/terasoluna/gfw/common/validator/constraints/ByteMax.java b/...-gfw-validator/src/main/java/org/terasoluna/gfw/common/validator/constraints/ByteMax.java
@@ -37,6 +37,9 @@
  * The annotated element must be a {@link CharSequence}({@link String}, {@link StringBuilder}, etc ...) whose byte length must
  * be lower or equal to the specified maximum.
  * <p>
+ * If you want to specify not only a maximum length but also a minimum length, it is recommended to use {@link ByteSize}.
+ * </p>
+ * <p>
  * Supported types are:
  * </p>
  * <ul>
@@ -50,6 +53,7 @@
  * </p>
  * @since 5.1.0
  * @see ByteMaxValidator
+ * @see ByteSize
  */
 @Documented
 @Constraint(validatedBy = { ByteMaxValidator.class })

diff --git a/...-gfw-validator/src/main/java/org/terasoluna/gfw/common/validator/constraints/ByteMin.java b/...-gfw-validator/src/main/java/org/terasoluna/gfw/common/validator/constraints/ByteMin.java
@@ -37,6 +37,9 @@
  * The annotated element must be a {@link CharSequence}({@link String}, {@link StringBuilder}, etc ...) whose byte length must
  * be higher or equal to the specified minimum.
  * <p>
+ * If you want to specify not only a minimum length but also a maximum length, it is recommended to use {@link ByteSize}.
+ * </p>
+ * <p>
  * Supported types are:
  * </p>
  * <ul>
@@ -50,6 +53,7 @@
  * </p>
  * @since 5.1.0
  * @see ByteMinValidator
+ * @see ByteSize
  */
 @Documented
 @Constraint(validatedBy = { ByteMinValidator.class })

diff --git a/...gfw-validator/src/main/java/org/terasoluna/gfw/common/validator/constraints/ByteSize.java b/...gfw-validator/src/main/java/org/terasoluna/gfw/common/validator/constraints/ByteSize.java
@@ -55,6 +55,8 @@
  * </p>
  * @since 5.4.0
  * @see ByteSizeValidator
+ * @see ByteMin
+ * @see ByteMax
  */
 @Documented
 @Constraint(validatedBy = { ByteSizeValidator.class })
@@ -98,7 +100,7 @@
     /**
      * Defines several {@link ByteSize} annotations on the same element.
      * @see ByteSize
-     * @since 5.1.0
+     * @since 5.4.0
      */
     @Documented
     @Target({ METHOD, FIELD, TYPE, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })