This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-validator.git
The following commit(s) were added to refs/heads/master by this push: new 35f43a63 Javadoc: Use {@code } instead of HTML tags. 35f43a63 is described below commit 35f43a63bd1689961ada7fcea4d3cab81747b5d7 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Fri Apr 28 15:11:47 2023 -0400 Javadoc: Use {@code } instead of HTML tags. --- .../java/org/apache/commons/validator/Arg.java | 2 +- .../apache/commons/validator/DateValidator.java | 4 +- .../java/org/apache/commons/validator/Field.java | 8 ++-- .../apache/commons/validator/GenericValidator.java | 4 +- .../java/org/apache/commons/validator/Msg.java | 2 +- .../org/apache/commons/validator/Validator.java | 2 +- .../apache/commons/validator/ValidatorAction.java | 4 +- .../apache/commons/validator/ValidatorResults.java | 4 +- .../java/org/apache/commons/validator/Var.java | 2 +- .../routines/AbstractCalendarValidator.java | 4 +- .../routines/AbstractFormatValidator.java | 16 +++---- .../routines/AbstractNumberValidator.java | 18 +++---- .../validator/routines/BigDecimalValidator.java | 14 +++--- .../validator/routines/BigIntegerValidator.java | 8 ++-- .../commons/validator/routines/ByteValidator.java | 14 +++--- .../validator/routines/CalendarValidator.java | 2 +- .../commons/validator/routines/CodeValidator.java | 8 ++-- .../validator/routines/CurrencyValidator.java | 6 +-- .../commons/validator/routines/DateValidator.java | 2 +- .../validator/routines/DoubleValidator.java | 14 +++--- .../commons/validator/routines/FloatValidator.java | 14 +++--- .../commons/validator/routines/IBANValidator.java | 2 +- .../commons/validator/routines/ISBNValidator.java | 24 +++++----- .../commons/validator/routines/ISINValidator.java | 4 +- .../commons/validator/routines/ISSNValidator.java | 4 +- .../validator/routines/IntegerValidator.java | 14 +++--- .../commons/validator/routines/LongValidator.java | 14 +++--- .../validator/routines/PercentValidator.java | 2 +- .../commons/validator/routines/RegexValidator.java | 10 ++-- .../commons/validator/routines/ShortValidator.java | 14 +++--- .../commons/validator/routines/TimeValidator.java | 2 +- .../validator/routines/checkdigit/CheckDigit.java | 4 +- .../routines/checkdigit/IBANCheckDigit.java | 4 +- .../routines/checkdigit/ISBNCheckDigit.java | 4 +- .../routines/checkdigit/ModulusCheckDigit.java | 4 +- .../routines/checkdigit/ModulusTenCheckDigit.java | 10 ++-- .../routines/checkdigit/VerhoeffCheckDigit.java | 4 +- .../commons/validator/routines/package-info.java | 4 +- .../validator/GenericTypeValidatorImpl.java | 56 +++++++++++----------- .../commons/validator/GenericValidatorImpl.java | 32 ++++++------- 40 files changed, 182 insertions(+), 182 deletions(-) diff --git a/src/main/java/org/apache/commons/validator/Arg.java b/src/main/java/org/apache/commons/validator/Arg.java index 55c416c9..7bed4c96 100644 --- a/src/main/java/org/apache/commons/validator/Arg.java +++ b/src/main/java/org/apache/commons/validator/Arg.java @@ -118,7 +118,7 @@ public class Arg implements Cloneable, Serializable { /** * Tests whether or not the key is a resource key or literal value. - * @return <code>true</code> if key is a resource key. + * @return {@code true} if key is a resource key. */ public boolean isResource() { return this.resource; diff --git a/src/main/java/org/apache/commons/validator/DateValidator.java b/src/main/java/org/apache/commons/validator/DateValidator.java index 374b4c08..37517fa2 100644 --- a/src/main/java/org/apache/commons/validator/DateValidator.java +++ b/src/main/java/org/apache/commons/validator/DateValidator.java @@ -59,7 +59,7 @@ public class DateValidator { * <code>java.text.SimpleDateFormat</code>. If strict is true, then the * length will be checked so '2/12/1999' will not pass validation with * the format 'MM/dd/yyyy' because the month isn't two digits. - * The setLenient method is set to <code>false</code> for all.</p> + * The setLenient method is set to {@code false} for all.</p> * * @param value The value validation is being performed on. * @param datePattern The pattern passed to <code>SimpleDateFormat</code>. @@ -94,7 +94,7 @@ public class DateValidator { /** * <p>Checks if the field is a valid date. The <code>Locale</code> is * used with <code>java.text.DateFormat</code>. The setLenient method - * is set to <code>false</code> for all.</p> + * is set to {@code false} for all.</p> * * @param value The value validation is being performed on. * @param locale The locale to use for the date format, defaults to the default diff --git a/src/main/java/org/apache/commons/validator/Field.java b/src/main/java/org/apache/commons/validator/Field.java index 44adc603..b9640280 100644 --- a/src/main/java/org/apache/commons/validator/Field.java +++ b/src/main/java/org/apache/commons/validator/Field.java @@ -301,8 +301,8 @@ public class Field implements Cloneable, Serializable { /** * Determines whether client-side scripting should be generated - * for this field. The default is <code>true</code> - * @return <code>true</code> for scripting; otherwise false + * for this field. The default is {@code true} + * @return {@code true} for scripting; otherwise false * @see #setClientValidation(boolean) * @since 1.4 */ @@ -535,8 +535,8 @@ public class Field implements Cloneable, Serializable { /** * If there is a value specified for the indexedProperty field then - * <code>true</code> will be returned. Otherwise it will be - * <code>false</code>. + * {@code true} will be returned. Otherwise it will be + * {@code false}. * @return Whether the Field is indexed. */ public boolean isIndexed() { diff --git a/src/main/java/org/apache/commons/validator/GenericValidator.java b/src/main/java/org/apache/commons/validator/GenericValidator.java index 9f1f5cb3..636a90ae 100644 --- a/src/main/java/org/apache/commons/validator/GenericValidator.java +++ b/src/main/java/org/apache/commons/validator/GenericValidator.java @@ -132,7 +132,7 @@ public class GenericValidator implements Serializable { /** * <p>Checks if the field is a valid date. The <code>Locale</code> is * used with <code>java.text.DateFormat</code>. The setLenient method - * is set to <code>false</code> for all.</p> + * is set to {@code false} for all.</p> * * @param value The value validation is being performed on. * @param locale The locale to use for the date format, defaults to the @@ -148,7 +148,7 @@ public class GenericValidator implements Serializable { * <code>java.text.SimpleDateFormat</code>. If strict is true, then the * length will be checked so '2/12/1999' will not pass validation with * the format 'MM/dd/yyyy' because the month isn't two digits. - * The setLenient method is set to <code>false</code> for all.</p> + * The setLenient method is set to {@code false} for all.</p> * * @param value The value validation is being performed on. * @param datePattern The pattern passed to <code>SimpleDateFormat</code>. diff --git a/src/main/java/org/apache/commons/validator/Msg.java b/src/main/java/org/apache/commons/validator/Msg.java index e187d2ef..caf128d9 100644 --- a/src/main/java/org/apache/commons/validator/Msg.java +++ b/src/main/java/org/apache/commons/validator/Msg.java @@ -106,7 +106,7 @@ public class Msg implements Cloneable, Serializable { /** * Tests whether or not the key is a resource key or literal value. - * @return <code>true</code> if key is a resource key. + * @return {@code true} if key is a resource key. * @since 1.1.4 */ public boolean isResource() { diff --git a/src/main/java/org/apache/commons/validator/Validator.java b/src/main/java/org/apache/commons/validator/Validator.java index add20bc1..e6005ba3 100644 --- a/src/main/java/org/apache/commons/validator/Validator.java +++ b/src/main/java/org/apache/commons/validator/Validator.java @@ -124,7 +124,7 @@ public class Validator implements Serializable { /** * Whether or not to use the Context ClassLoader when loading classes - * for instantiating new objects. Default is <code>false</code>. + * for instantiating new objects. Default is {@code false}. */ protected boolean useContextClassLoader; diff --git a/src/main/java/org/apache/commons/validator/ValidatorAction.java b/src/main/java/org/apache/commons/validator/ValidatorAction.java index 6f6df6c2..62922a13 100644 --- a/src/main/java/org/apache/commons/validator/ValidatorAction.java +++ b/src/main/java/org/apache/commons/validator/ValidatorAction.java @@ -734,8 +734,8 @@ public class ValidatorAction implements Serializable { /** * If the result object is a <code>Boolean</code>, it will return its - * value. If not it will return <code>false</code> if the object is - * <code>null</code> and <code>true</code> if it isn't. + * value. If not it will return {@code false} if the object is + * <code>null</code> and {@code true} if it isn't. */ private boolean isValid(final Object result) { if (result instanceof Boolean) { diff --git a/src/main/java/org/apache/commons/validator/ValidatorResults.java b/src/main/java/org/apache/commons/validator/ValidatorResults.java index 351c3184..28fe66f6 100644 --- a/src/main/java/org/apache/commons/validator/ValidatorResults.java +++ b/src/main/java/org/apache/commons/validator/ValidatorResults.java @@ -89,8 +89,8 @@ public class ValidatorResults implements Serializable { } /** - * Return <code>true</code> if there are no messages recorded - * in this collection, or <code>false</code> otherwise. + * Return {@code true} if there are no messages recorded + * in this collection, or {@code false} otherwise. * * @return Whether these results are empty. */ diff --git a/src/main/java/org/apache/commons/validator/Var.java b/src/main/java/org/apache/commons/validator/Var.java index 5527cbde..e60805a4 100644 --- a/src/main/java/org/apache/commons/validator/Var.java +++ b/src/main/java/org/apache/commons/validator/Var.java @@ -123,7 +123,7 @@ public class Var implements Cloneable, Serializable { /** * Tests whether or not the value is a resource key or literal value. - * @return <code>true</code> if value is a resource key. + * @return {@code true} if value is a resource key. * @since 1.2.0 */ public boolean isResource() { diff --git a/src/main/java/org/apache/commons/validator/routines/AbstractCalendarValidator.java b/src/main/java/org/apache/commons/validator/routines/AbstractCalendarValidator.java index 18c3d6af..61475652 100644 --- a/src/main/java/org/apache/commons/validator/routines/AbstractCalendarValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/AbstractCalendarValidator.java @@ -44,7 +44,7 @@ public abstract class AbstractCalendarValidator extends AbstractFormatValidator * Construct an instance with the specified <i>strict</i>, * <i>time</i> and <i>date</i> style parameters. * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. * @param dateStyle the date style to use for Locale validation. * @param timeStyle the time style to use for Locale validation. @@ -61,7 +61,7 @@ public abstract class AbstractCalendarValidator extends AbstractFormatValidator * @param value The value validation is being performed on. * @param pattern The pattern used to format the value. * @param locale The locale to use for the Format, defaults to the default - * @return <code>true</code> if the value is valid. + * @return {@code true} if the value is valid. */ @Override public boolean isValid(final String value, final String pattern, final Locale locale) { diff --git a/src/main/java/org/apache/commons/validator/routines/AbstractFormatValidator.java b/src/main/java/org/apache/commons/validator/routines/AbstractFormatValidator.java index 2c62f037..b2f84131 100644 --- a/src/main/java/org/apache/commons/validator/routines/AbstractFormatValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/AbstractFormatValidator.java @@ -38,7 +38,7 @@ public abstract class AbstractFormatValidator implements Serializable { /** * Construct an instance with the specified strict setting. * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. */ public AbstractFormatValidator(final boolean strict) { @@ -55,11 +55,11 @@ public abstract class AbstractFormatValidator implements Serializable { * value of <code>01/01/20x0</code> using a pattern * of <code>dd/MM/yyyy</code> will result in a year * of <code>20</code> if <code>strict</code> is set - * to <code>false</code>, whereas setting <code>strict</code> - * to <code>true</code> will cause this value to fail + * to {@code false}, whereas setting <code>strict</code> + * to {@code true} will cause this value to fail * validation.</p> * - * @return <code>true</code> if strict <code>Format</code> + * @return {@code true} if strict <code>Format</code> * parsing should be used. */ public boolean isStrict() { @@ -70,7 +70,7 @@ public abstract class AbstractFormatValidator implements Serializable { * <p>Validate using the default <code>Locale</code>. * * @param value The value validation is being performed on. - * @return <code>true</code> if the value is valid. + * @return {@code true} if the value is valid. */ public boolean isValid(final String value) { return isValid(value, (String)null, (Locale)null); @@ -81,7 +81,7 @@ public abstract class AbstractFormatValidator implements Serializable { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against. - * @return <code>true</code> if the value is valid. + * @return {@code true} if the value is valid. */ public boolean isValid(final String value, final String pattern) { return isValid(value, pattern, (Locale)null); @@ -92,7 +92,7 @@ public abstract class AbstractFormatValidator implements Serializable { * * @param value The value validation is being performed on. * @param locale The locale to use for the Format, defaults to the default - * @return <code>true</code> if the value is valid. + * @return {@code true} if the value is valid. */ public boolean isValid(final String value, final Locale locale) { return isValid(value, (String)null, locale); @@ -104,7 +104,7 @@ public abstract class AbstractFormatValidator implements Serializable { * @param value The value validation is being performed on. * @param pattern The pattern used to format the value. * @param locale The locale to use for the Format, defaults to the default - * @return <code>true</code> if the value is valid. + * @return {@code true} if the value is valid. */ public abstract boolean isValid(String value, String pattern, Locale locale); diff --git a/src/main/java/org/apache/commons/validator/routines/AbstractNumberValidator.java b/src/main/java/org/apache/commons/validator/routines/AbstractNumberValidator.java index 61ecdf5c..7bbf099b 100644 --- a/src/main/java/org/apache/commons/validator/routines/AbstractNumberValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/AbstractNumberValidator.java @@ -50,12 +50,12 @@ public abstract class AbstractNumberValidator extends AbstractFormatValidator { * Construct an instance with specified <i>strict</i> * and <i>decimal</i> parameters. * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. * @param formatType The <code>NumberFormat</code> type to * create for validation, default is STANDARD_FORMAT. - * @param allowFractions <code>true</code> if fractions are - * allowed or <code>false</code> if integers only. + * @param allowFractions {@code true} if fractions are + * allowed or {@code false} if integers only. */ public AbstractNumberValidator(final boolean strict, final int formatType, final boolean allowFractions) { super(strict); @@ -67,8 +67,8 @@ public abstract class AbstractNumberValidator extends AbstractFormatValidator { * <p>Indicates whether the number being validated is * a decimal or integer.</p> * - * @return <code>true</code> if decimals are allowed - * or <code>false</code> if the number is an integer. + * @return {@code true} if decimals are allowed + * or {@code false} if the number is an integer. */ public boolean isAllowFractions() { return allowFractions; @@ -91,7 +91,7 @@ public abstract class AbstractNumberValidator extends AbstractFormatValidator { * @param pattern The pattern used to validate the value against, or the * default for the <code>Locale</code> if <code>null</code>. * @param locale The locale to use for the date format, system default if null. - * @return <code>true</code> if the value is valid. + * @return {@code true} if the value is valid. */ @Override public boolean isValid(final String value, final String pattern, final Locale locale) { @@ -105,7 +105,7 @@ public abstract class AbstractNumberValidator extends AbstractFormatValidator { * @param value The value validation is being performed on. * @param min The minimum value of the range. * @param max The maximum value of the range. - * @return <code>true</code> if the value is within the + * @return {@code true} if the value is within the * specified range. */ public boolean isInRange(final Number value, final Number min, final Number max) { @@ -117,7 +117,7 @@ public abstract class AbstractNumberValidator extends AbstractFormatValidator { * * @param value The value validation is being performed on. * @param min The minimum value. - * @return <code>true</code> if the value is greater than + * @return {@code true} if the value is greater than * or equal to the minimum. */ public boolean minValue(final Number value, final Number min) { @@ -132,7 +132,7 @@ public abstract class AbstractNumberValidator extends AbstractFormatValidator { * * @param value The value validation is being performed on. * @param max The maximum value. - * @return <code>true</code> if the value is less than + * @return {@code true} if the value is less than * or equal to the maximum. */ public boolean maxValue(final Number value, final Number max) { diff --git a/src/main/java/org/apache/commons/validator/routines/BigDecimalValidator.java b/src/main/java/org/apache/commons/validator/routines/BigDecimalValidator.java index 7401f1ea..2390b6a5 100644 --- a/src/main/java/org/apache/commons/validator/routines/BigDecimalValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/BigDecimalValidator.java @@ -89,7 +89,7 @@ public class BigDecimalValidator extends AbstractNumberValidator { /** * <p>Construct an instance with the specified strict setting.</p> * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. */ public BigDecimalValidator(final boolean strict) { @@ -112,12 +112,12 @@ public class BigDecimalValidator extends AbstractNumberValidator { * <i>percent</i> number formats (the default).</li> * </ul> * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. * @param formatType The <code>NumberFormat</code> type to * create for validation, default is STANDARD_FORMAT. - * @param allowFractions <code>true</code> if fractions are - * allowed or <code>false</code> if integers only. + * @param allowFractions {@code true} if fractions are + * allowed or {@code false} if integers only. */ protected BigDecimalValidator(final boolean strict, final int formatType, final boolean allowFractions) { @@ -181,7 +181,7 @@ public class BigDecimalValidator extends AbstractNumberValidator { * @param value The <code>Number</code> value to check. * @param min The minimum value of the range. * @param max The maximum value of the range. - * @return <code>true</code> if the value is within the + * @return {@code true} if the value is within the * specified range. */ public boolean isInRange(final BigDecimal value, final double min, final double max) { @@ -193,7 +193,7 @@ public class BigDecimalValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param min The minimum value. - * @return <code>true</code> if the value is greater than + * @return {@code true} if the value is greater than * or equal to the minimum. */ public boolean minValue(final BigDecimal value, final double min) { @@ -205,7 +205,7 @@ public class BigDecimalValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param max The maximum value. - * @return <code>true</code> if the value is less than + * @return {@code true} if the value is less than * or equal to the maximum. */ public boolean maxValue(final BigDecimal value, final double max) { diff --git a/src/main/java/org/apache/commons/validator/routines/BigIntegerValidator.java b/src/main/java/org/apache/commons/validator/routines/BigIntegerValidator.java index 6f9bd101..33b67da0 100644 --- a/src/main/java/org/apache/commons/validator/routines/BigIntegerValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/BigIntegerValidator.java @@ -99,7 +99,7 @@ public class BigIntegerValidator extends AbstractNumberValidator { * <i>percent</i> number formats (the default).</li> * </ul> * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. * @param formatType The <code>NumberFormat</code> type to * create for validation, default is STANDARD_FORMAT. @@ -164,7 +164,7 @@ public class BigIntegerValidator extends AbstractNumberValidator { * @param value The <code>Number</code> value to check. * @param min The minimum value of the range. * @param max The maximum value of the range. - * @return <code>true</code> if the value is within the + * @return {@code true} if the value is within the * specified range. */ public boolean isInRange(final BigInteger value, final long min, final long max) { @@ -176,7 +176,7 @@ public class BigIntegerValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param min The minimum value. - * @return <code>true</code> if the value is greater than + * @return {@code true} if the value is greater than * or equal to the minimum. */ public boolean minValue(final BigInteger value, final long min) { @@ -188,7 +188,7 @@ public class BigIntegerValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param max The maximum value. - * @return <code>true</code> if the value is less than + * @return {@code true} if the value is less than * or equal to the maximum. */ public boolean maxValue(final BigInteger value, final long max) { diff --git a/src/main/java/org/apache/commons/validator/routines/ByteValidator.java b/src/main/java/org/apache/commons/validator/routines/ByteValidator.java index 34a3ada6..e237c9db 100644 --- a/src/main/java/org/apache/commons/validator/routines/ByteValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/ByteValidator.java @@ -98,7 +98,7 @@ public class ByteValidator extends AbstractNumberValidator { * <i>percent</i> number formats (the default).</li> * </ul> * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. * @param formatType The <code>NumberFormat</code> type to * create for validation, default is STANDARD_FORMAT. @@ -163,7 +163,7 @@ public class ByteValidator extends AbstractNumberValidator { * @param value The <code>Number</code> value to check. * @param min The minimum value of the range. * @param max The maximum value of the range. - * @return <code>true</code> if the value is within the + * @return {@code true} if the value is within the * specified range. */ public boolean isInRange(final byte value, final byte min, final byte max) { @@ -176,7 +176,7 @@ public class ByteValidator extends AbstractNumberValidator { * @param value The <code>Number</code> value to check. * @param min The minimum value of the range. * @param max The maximum value of the range. - * @return <code>true</code> if the value is within the + * @return {@code true} if the value is within the * specified range. */ public boolean isInRange(final Byte value, final byte min, final byte max) { @@ -188,7 +188,7 @@ public class ByteValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param min The minimum value. - * @return <code>true</code> if the value is greater than + * @return {@code true} if the value is greater than * or equal to the minimum. */ public boolean minValue(final byte value, final byte min) { @@ -200,7 +200,7 @@ public class ByteValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param min The minimum value. - * @return <code>true</code> if the value is greater than + * @return {@code true} if the value is greater than * or equal to the minimum. */ public boolean minValue(final Byte value, final byte min) { @@ -212,7 +212,7 @@ public class ByteValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param max The maximum value. - * @return <code>true</code> if the value is less than + * @return {@code true} if the value is less than * or equal to the maximum. */ public boolean maxValue(final byte value, final byte max) { @@ -224,7 +224,7 @@ public class ByteValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param max The maximum value. - * @return <code>true</code> if the value is less than + * @return {@code true} if the value is less than * or equal to the maximum. */ public boolean maxValue(final Byte value, final byte max) { diff --git a/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java b/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java index 1700e82a..06f00f4f 100644 --- a/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java @@ -110,7 +110,7 @@ public class CalendarValidator extends AbstractCalendarValidator { * Construct an instance with the specified <i>strict</i> * and <i>date style</i> parameters. * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. * @param dateStyle the date style to use for Locale validation. */ diff --git a/src/main/java/org/apache/commons/validator/routines/CodeValidator.java b/src/main/java/org/apache/commons/validator/routines/CodeValidator.java index 689b2b70..e58ebbdc 100644 --- a/src/main/java/org/apache/commons/validator/routines/CodeValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/CodeValidator.java @@ -215,8 +215,8 @@ public final class CodeValidator implements Serializable { } /** - * Validate the code returning either <code>true</code> - * or <code>false</code>. + * Validate the code returning either {@code true} + * or {@code false}. * <p> * This calls {@link #validate(String)} and returns false * if the return value is null, true otherwise. @@ -226,8 +226,8 @@ public final class CodeValidator implements Serializable { * change the input as part of the validation. * * @param input The code to validate - * @return <code>true</code> if valid, otherwise - * <code>false</code> + * @return {@code true} if valid, otherwise + * {@code false} */ public boolean isValid(final String input) { return (validate(input) != null); diff --git a/src/main/java/org/apache/commons/validator/routines/CurrencyValidator.java b/src/main/java/org/apache/commons/validator/routines/CurrencyValidator.java index 34ba6ed4..85da93f9 100644 --- a/src/main/java/org/apache/commons/validator/routines/CurrencyValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/CurrencyValidator.java @@ -68,10 +68,10 @@ public class CurrencyValidator extends BigDecimalValidator { /** * Construct an instance with the specified strict setting. * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. - * @param allowFractions <code>true</code> if fractions are - * allowed or <code>false</code> if integers only. + * @param allowFractions {@code true} if fractions are + * allowed or {@code false} if integers only. */ public CurrencyValidator(final boolean strict, final boolean allowFractions) { super(strict, CURRENCY_FORMAT, allowFractions); diff --git a/src/main/java/org/apache/commons/validator/routines/DateValidator.java b/src/main/java/org/apache/commons/validator/routines/DateValidator.java index 69895805..713778f8 100644 --- a/src/main/java/org/apache/commons/validator/routines/DateValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/DateValidator.java @@ -107,7 +107,7 @@ public class DateValidator extends AbstractCalendarValidator { * Construct an instance with the specified <i>strict</i> * and <i>date style</i> parameters. * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. * @param dateStyle the date style to use for Locale validation. */ diff --git a/src/main/java/org/apache/commons/validator/routines/DoubleValidator.java b/src/main/java/org/apache/commons/validator/routines/DoubleValidator.java index e3cbd482..acf312d1 100644 --- a/src/main/java/org/apache/commons/validator/routines/DoubleValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/DoubleValidator.java @@ -98,7 +98,7 @@ public class DoubleValidator extends AbstractNumberValidator { * <i>percent</i> number formats (the default).</li> * </ul> * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. * @param formatType The <code>NumberFormat</code> type to * create for validation, default is STANDARD_FORMAT. @@ -163,7 +163,7 @@ public class DoubleValidator extends AbstractNumberValidator { * @param value The <code>Number</code> value to check. * @param min The minimum value of the range. * @param max The maximum value of the range. - * @return <code>true</code> if the value is within the + * @return {@code true} if the value is within the * specified range. */ public boolean isInRange(final double value, final double min, final double max) { @@ -176,7 +176,7 @@ public class DoubleValidator extends AbstractNumberValidator { * @param value The <code>Number</code> value to check. * @param min The minimum value of the range. * @param max The maximum value of the range. - * @return <code>true</code> if the value is within the + * @return {@code true} if the value is within the * specified range. */ public boolean isInRange(final Double value, final double min, final double max) { @@ -188,7 +188,7 @@ public class DoubleValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param min The minimum value. - * @return <code>true</code> if the value is greater than + * @return {@code true} if the value is greater than * or equal to the minimum. */ public boolean minValue(final double value, final double min) { @@ -200,7 +200,7 @@ public class DoubleValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param min The minimum value. - * @return <code>true</code> if the value is greater than + * @return {@code true} if the value is greater than * or equal to the minimum. */ public boolean minValue(final Double value, final double min) { @@ -212,7 +212,7 @@ public class DoubleValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param max The maximum value. - * @return <code>true</code> if the value is less than + * @return {@code true} if the value is less than * or equal to the maximum. */ public boolean maxValue(final double value, final double max) { @@ -224,7 +224,7 @@ public class DoubleValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param max The maximum value. - * @return <code>true</code> if the value is less than + * @return {@code true} if the value is less than * or equal to the maximum. */ public boolean maxValue(final Double value, final double max) { diff --git a/src/main/java/org/apache/commons/validator/routines/FloatValidator.java b/src/main/java/org/apache/commons/validator/routines/FloatValidator.java index f1c22b50..97ad3781 100644 --- a/src/main/java/org/apache/commons/validator/routines/FloatValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/FloatValidator.java @@ -98,7 +98,7 @@ public class FloatValidator extends AbstractNumberValidator { * <i>percent</i> number formats (the default).</li> * </ul> * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. * @param formatType The <code>NumberFormat</code> type to * create for validation, default is STANDARD_FORMAT. @@ -163,7 +163,7 @@ public class FloatValidator extends AbstractNumberValidator { * @param value The <code>Number</code> value to check. * @param min The minimum value of the range. * @param max The maximum value of the range. - * @return <code>true</code> if the value is within the + * @return {@code true} if the value is within the * specified range. */ public boolean isInRange(final float value, final float min, final float max) { @@ -176,7 +176,7 @@ public class FloatValidator extends AbstractNumberValidator { * @param value The <code>Number</code> value to check. * @param min The minimum value of the range. * @param max The maximum value of the range. - * @return <code>true</code> if the value is within the + * @return {@code true} if the value is within the * specified range. */ public boolean isInRange(final Float value, final float min, final float max) { @@ -188,7 +188,7 @@ public class FloatValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param min The minimum value. - * @return <code>true</code> if the value is greater than + * @return {@code true} if the value is greater than * or equal to the minimum. */ public boolean minValue(final float value, final float min) { @@ -200,7 +200,7 @@ public class FloatValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param min The minimum value. - * @return <code>true</code> if the value is greater than + * @return {@code true} if the value is greater than * or equal to the minimum. */ public boolean minValue(final Float value, final float min) { @@ -212,7 +212,7 @@ public class FloatValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param max The maximum value. - * @return <code>true</code> if the value is less than + * @return {@code true} if the value is less than * or equal to the maximum. */ public boolean maxValue(final float value, final float max) { @@ -224,7 +224,7 @@ public class FloatValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param max The maximum value. - * @return <code>true</code> if the value is less than + * @return {@code true} if the value is less than * or equal to the maximum. */ public boolean maxValue(final Float value, final float max) { diff --git a/src/main/java/org/apache/commons/validator/routines/IBANValidator.java b/src/main/java/org/apache/commons/validator/routines/IBANValidator.java index f98c1c21..b8263349 100644 --- a/src/main/java/org/apache/commons/validator/routines/IBANValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/IBANValidator.java @@ -280,7 +280,7 @@ public class IBANValidator { * Validate an IBAN Code * * @param code The value validation is being performed on - * @return <code>true</code> if the value is valid + * @return {@code true} if the value is valid */ public boolean isValid(final String code) { final Validator formatValidator = getValidator(code); diff --git a/src/main/java/org/apache/commons/validator/routines/ISBNValidator.java b/src/main/java/org/apache/commons/validator/routines/ISBNValidator.java index e2ea4c38..0a1eb6fb 100644 --- a/src/main/java/org/apache/commons/validator/routines/ISBNValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/ISBNValidator.java @@ -34,7 +34,7 @@ import org.apache.commons.validator.routines.checkdigit.ISBN10CheckDigit; * characters removed if valid or <code>null</code> if invalid. * <p> * This validator also provides the facility to convert ISBN-10 codes to - * ISBN-13 if the <code>convert</code> property is <code>true</code>. + * ISBN-13 if the <code>convert</code> property is {@code true}. * <p> * From 1st January 2007 the book industry will start to use a new 13 digit * ISBN number (rather than this 10 digit ISBN number). ISBN-13 codes are @@ -120,8 +120,8 @@ public class ISBNValidator implements Serializable { * Return a singleton instance of the ISBN validator specifying * whether ISBN-10 codes should be converted to ISBN-13. * - * @param convert <code>true</code> if valid ISBN-10 codes - * should be converted to ISBN-13 codes or <code>false</code> + * @param convert {@code true} if valid ISBN-10 codes + * should be converted to ISBN-13 codes or {@code false} * if valid ISBN-10 codes should be returned unchanged. * @return A singleton instance of the ISBN validator. */ @@ -141,8 +141,8 @@ public class ISBNValidator implements Serializable { * Construct an ISBN validator indicating whether * ISBN-10 codes should be converted to ISBN-13. * - * @param convert <code>true</code> if valid ISBN-10 codes - * should be converted to ISBN-13 codes or <code>false</code> + * @param convert {@code true} if valid ISBN-10 codes + * should be converted to ISBN-13 codes or {@code false} * if valid ISBN-10 codes should be returned unchanged. */ public ISBNValidator(final boolean convert) { @@ -153,8 +153,8 @@ public class ISBNValidator implements Serializable { * Check the code is either a valid ISBN-10 or ISBN-13 code. * * @param code The code to validate. - * @return <code>true</code> if a valid ISBN-10 or - * ISBN-13 code, otherwise <code>false</code>. + * @return {@code true} if a valid ISBN-10 or + * ISBN-13 code, otherwise {@code false}. */ public boolean isValid(final String code) { return isValidISBN13(code) || isValidISBN10(code); @@ -164,8 +164,8 @@ public class ISBNValidator implements Serializable { * Check the code is a valid ISBN-10 code. * * @param code The code to validate. - * @return <code>true</code> if a valid ISBN-10 - * code, otherwise <code>false</code>. + * @return {@code true} if a valid ISBN-10 + * code, otherwise {@code false}. */ public boolean isValidISBN10(final String code) { return isbn10Validator.isValid(code); @@ -175,8 +175,8 @@ public class ISBNValidator implements Serializable { * Check the code is a valid ISBN-13 code. * * @param code The code to validate. - * @return <code>true</code> if a valid ISBN-13 - * code, otherwise <code>false</code>. + * @return {@code true} if a valid ISBN-13 + * code, otherwise {@code false}. */ public boolean isValidISBN13(final String code) { return isbn13Validator.isValid(code); @@ -189,7 +189,7 @@ public class ISBNValidator implements Serializable { * formatting characters removed (i.e. space or hyphen). * <p> * Converts an ISBN-10 codes to ISBN-13 if - * <code>convertToISBN13</code> is <code>true</code>. + * <code>convertToISBN13</code> is {@code true}. * * @param code The code to validate. * @return A valid ISBN code if valid, otherwise <code>null</code>. diff --git a/src/main/java/org/apache/commons/validator/routines/ISINValidator.java b/src/main/java/org/apache/commons/validator/routines/ISINValidator.java index acdc18b7..6ec54dba 100644 --- a/src/main/java/org/apache/commons/validator/routines/ISINValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/ISINValidator.java @@ -89,8 +89,8 @@ public class ISINValidator implements Serializable { * Check the code is a valid ISIN code after any transformation * by the validate routine. * @param code The code to validate. - * @return <code>true</code> if a valid ISIN - * code, otherwise <code>false</code>. + * @return {@code true} if a valid ISIN + * code, otherwise {@code false}. */ public boolean isValid(final String code) { final boolean valid = VALIDATOR.isValid(code); diff --git a/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java b/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java index 06263dcb..7824f72f 100644 --- a/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java @@ -107,8 +107,8 @@ public class ISSNValidator implements Serializable { * Check the code is a valid ISSN code after any transformation * by the validate routine. * @param code The code to validate. - * @return <code>true</code> if a valid ISSN - * code, otherwise <code>false</code>. + * @return {@code true} if a valid ISSN + * code, otherwise {@code false}. */ public boolean isValid(final String code) { return VALIDATOR.isValid(code); diff --git a/src/main/java/org/apache/commons/validator/routines/IntegerValidator.java b/src/main/java/org/apache/commons/validator/routines/IntegerValidator.java index 99990cb3..34b51c8e 100644 --- a/src/main/java/org/apache/commons/validator/routines/IntegerValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/IntegerValidator.java @@ -98,7 +98,7 @@ public class IntegerValidator extends AbstractNumberValidator { * <i>percent</i> number formats (the default).</li> * </ul> * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. * @param formatType The <code>NumberFormat</code> type to * create for validation, default is STANDARD_FORMAT. @@ -163,7 +163,7 @@ public class IntegerValidator extends AbstractNumberValidator { * @param value The <code>Number</code> value to check. * @param min The minimum value of the range. * @param max The maximum value of the range. - * @return <code>true</code> if the value is within the + * @return {@code true} if the value is within the * specified range. */ public boolean isInRange(final int value, final int min, final int max) { @@ -176,7 +176,7 @@ public class IntegerValidator extends AbstractNumberValidator { * @param value The <code>Number</code> value to check. * @param min The minimum value of the range. * @param max The maximum value of the range. - * @return <code>true</code> if the value is within the + * @return {@code true} if the value is within the * specified range. */ public boolean isInRange(final Integer value, final int min, final int max) { @@ -188,7 +188,7 @@ public class IntegerValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param min The minimum value. - * @return <code>true</code> if the value is greater than + * @return {@code true} if the value is greater than * or equal to the minimum. */ public boolean minValue(final int value, final int min) { @@ -200,7 +200,7 @@ public class IntegerValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param min The minimum value. - * @return <code>true</code> if the value is greater than + * @return {@code true} if the value is greater than * or equal to the minimum. */ public boolean minValue(final Integer value, final int min) { @@ -212,7 +212,7 @@ public class IntegerValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param max The maximum value. - * @return <code>true</code> if the value is less than + * @return {@code true} if the value is less than * or equal to the maximum. */ public boolean maxValue(final int value, final int max) { @@ -224,7 +224,7 @@ public class IntegerValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param max The maximum value. - * @return <code>true</code> if the value is less than + * @return {@code true} if the value is less than * or equal to the maximum. */ public boolean maxValue(final Integer value, final int max) { diff --git a/src/main/java/org/apache/commons/validator/routines/LongValidator.java b/src/main/java/org/apache/commons/validator/routines/LongValidator.java index f5e9dfb1..8ee9d8a0 100644 --- a/src/main/java/org/apache/commons/validator/routines/LongValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/LongValidator.java @@ -97,7 +97,7 @@ public class LongValidator extends AbstractNumberValidator { * <i>percent</i> number formats (the default).</li> * </ul> * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. * @param formatType The <code>NumberFormat</code> type to * create for validation, default is STANDARD_FORMAT. @@ -162,7 +162,7 @@ public class LongValidator extends AbstractNumberValidator { * @param value The <code>Number</code> value to check. * @param min The minimum value of the range. * @param max The maximum value of the range. - * @return <code>true</code> if the value is within the + * @return {@code true} if the value is within the * specified range. */ public boolean isInRange(final long value, final long min, final long max) { @@ -175,7 +175,7 @@ public class LongValidator extends AbstractNumberValidator { * @param value The <code>Number</code> value to check. * @param min The minimum value of the range. * @param max The maximum value of the range. - * @return <code>true</code> if the value is within the + * @return {@code true} if the value is within the * specified range. */ public boolean isInRange(final Long value, final long min, final long max) { @@ -187,7 +187,7 @@ public class LongValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param min The minimum value. - * @return <code>true</code> if the value is greater than + * @return {@code true} if the value is greater than * or equal to the minimum. */ public boolean minValue(final long value, final long min) { @@ -199,7 +199,7 @@ public class LongValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param min The minimum value. - * @return <code>true</code> if the value is greater than + * @return {@code true} if the value is greater than * or equal to the minimum. */ public boolean minValue(final Long value, final long min) { @@ -211,7 +211,7 @@ public class LongValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param max The maximum value. - * @return <code>true</code> if the value is less than + * @return {@code true} if the value is less than * or equal to the maximum. */ public boolean maxValue(final long value, final long max) { @@ -223,7 +223,7 @@ public class LongValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param max The maximum value. - * @return <code>true</code> if the value is less than + * @return {@code true} if the value is less than * or equal to the maximum. */ public boolean maxValue(final Long value, final long max) { diff --git a/src/main/java/org/apache/commons/validator/routines/PercentValidator.java b/src/main/java/org/apache/commons/validator/routines/PercentValidator.java index 089e233e..cad01b86 100644 --- a/src/main/java/org/apache/commons/validator/routines/PercentValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/PercentValidator.java @@ -73,7 +73,7 @@ public class PercentValidator extends BigDecimalValidator { /** * Construct an instance with the specified strict setting. * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. */ public PercentValidator(final boolean strict) { diff --git a/src/main/java/org/apache/commons/validator/routines/RegexValidator.java b/src/main/java/org/apache/commons/validator/routines/RegexValidator.java index c6f25dd5..2ea27da3 100644 --- a/src/main/java/org/apache/commons/validator/routines/RegexValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/RegexValidator.java @@ -38,7 +38,7 @@ import java.util.regex.Pattern; * </pre> * * <ul> - * <li>Validate <code>true</code> or <code>false</code>:</li> + * <li>Validate {@code true} or {@code false}:</li> * <li> * <ul> * <li><code>boolean valid = validator.isValid(value);</code></li> @@ -101,7 +101,7 @@ public class RegexValidator implements Serializable { * * @param regex The regular expression this validator will * validate against - * @param caseSensitive when <code>true</code> matching is <i>case + * @param caseSensitive when {@code true} matching is <i>case * sensitive</i>, otherwise matching is <i>case in-sensitive</i> */ public RegexValidator(final String regex, final boolean caseSensitive) { @@ -125,7 +125,7 @@ public class RegexValidator implements Serializable { * * @param regexs The set of regular expressions this validator will * validate against - * @param caseSensitive when <code>true</code> matching is <i>case + * @param caseSensitive when {@code true} matching is <i>case * sensitive</i>, otherwise matching is <i>case in-sensitive</i> */ public RegexValidator(final String[] regexs, final boolean caseSensitive) { @@ -156,8 +156,8 @@ public class RegexValidator implements Serializable { * Validates a value against the set of regular expressions. * * @param value The value to validate. - * @return <code>true</code> if the value is valid - * otherwise <code>false</code>. + * @return {@code true} if the value is valid + * otherwise {@code false}. */ public boolean isValid(final String value) { if (value == null) { diff --git a/src/main/java/org/apache/commons/validator/routines/ShortValidator.java b/src/main/java/org/apache/commons/validator/routines/ShortValidator.java index bf9ed8cf..65d97f53 100644 --- a/src/main/java/org/apache/commons/validator/routines/ShortValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/ShortValidator.java @@ -98,7 +98,7 @@ public class ShortValidator extends AbstractNumberValidator { * <i>percent</i> number formats (the default).</li> * </ul> * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. * @param formatType The <code>NumberFormat</code> type to * create for validation, default is STANDARD_FORMAT. @@ -163,7 +163,7 @@ public class ShortValidator extends AbstractNumberValidator { * @param value The <code>Number</code> value to check. * @param min The minimum value of the range. * @param max The maximum value of the range. - * @return <code>true</code> if the value is within the + * @return {@code true} if the value is within the * specified range. */ public boolean isInRange(final short value, final short min, final short max) { @@ -176,7 +176,7 @@ public class ShortValidator extends AbstractNumberValidator { * @param value The <code>Number</code> value to check. * @param min The minimum value of the range. * @param max The maximum value of the range. - * @return <code>true</code> if the value is within the + * @return {@code true} if the value is within the * specified range. */ public boolean isInRange(final Short value, final short min, final short max) { @@ -188,7 +188,7 @@ public class ShortValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param min The minimum value. - * @return <code>true</code> if the value is greater than + * @return {@code true} if the value is greater than * or equal to the minimum. */ public boolean minValue(final short value, final short min) { @@ -200,7 +200,7 @@ public class ShortValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param min The minimum value. - * @return <code>true</code> if the value is greater than + * @return {@code true} if the value is greater than * or equal to the minimum. */ public boolean minValue(final Short value, final short min) { @@ -212,7 +212,7 @@ public class ShortValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param max The maximum value. - * @return <code>true</code> if the value is less than + * @return {@code true} if the value is less than * or equal to the maximum. */ public boolean maxValue(final short value, final short max) { @@ -224,7 +224,7 @@ public class ShortValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param max The maximum value. - * @return <code>true</code> if the value is less than + * @return {@code true} if the value is less than * or equal to the maximum. */ public boolean maxValue(final Short value, final short max) { diff --git a/src/main/java/org/apache/commons/validator/routines/TimeValidator.java b/src/main/java/org/apache/commons/validator/routines/TimeValidator.java index b89bcf68..6856deac 100644 --- a/src/main/java/org/apache/commons/validator/routines/TimeValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/TimeValidator.java @@ -107,7 +107,7 @@ public class TimeValidator extends AbstractCalendarValidator { * Construct an instance with the specified <i>strict</i> * and <i>time style</i> parameters. * - * @param strict <code>true</code> if strict + * @param strict {@code true} if strict * <code>Format</code> parsing should be used. * @param timeStyle the time style to use for Locale validation. */ diff --git a/src/main/java/org/apache/commons/validator/routines/checkdigit/CheckDigit.java b/src/main/java/org/apache/commons/validator/routines/checkdigit/CheckDigit.java index f51d609d..7a4ff792 100644 --- a/src/main/java/org/apache/commons/validator/routines/checkdigit/CheckDigit.java +++ b/src/main/java/org/apache/commons/validator/routines/checkdigit/CheckDigit.java @@ -64,8 +64,8 @@ public interface CheckDigit { * Validates the check digit for the code. * * @param code The code to validate, the string must include the check digit. - * @return <code>true</code> if the check digit is valid, otherwise - * <code>false</code>. + * @return {@code true} if the check digit is valid, otherwise + * {@code false}. */ boolean isValid(String code); diff --git a/src/main/java/org/apache/commons/validator/routines/checkdigit/IBANCheckDigit.java b/src/main/java/org/apache/commons/validator/routines/checkdigit/IBANCheckDigit.java index 1f2a18fe..adab1437 100644 --- a/src/main/java/org/apache/commons/validator/routines/checkdigit/IBANCheckDigit.java +++ b/src/main/java/org/apache/commons/validator/routines/checkdigit/IBANCheckDigit.java @@ -64,8 +64,8 @@ public final class IBANCheckDigit implements CheckDigit, Serializable { * Validate the check digit of an IBAN code. * * @param code The code to validate - * @return <code>true</code> if the check digit is valid, otherwise - * <code>false</code> + * @return {@code true} if the check digit is valid, otherwise + * {@code false} */ @Override public boolean isValid(final String code) { diff --git a/src/main/java/org/apache/commons/validator/routines/checkdigit/ISBNCheckDigit.java b/src/main/java/org/apache/commons/validator/routines/checkdigit/ISBNCheckDigit.java index c325adbe..63d3dfe2 100644 --- a/src/main/java/org/apache/commons/validator/routines/checkdigit/ISBNCheckDigit.java +++ b/src/main/java/org/apache/commons/validator/routines/checkdigit/ISBNCheckDigit.java @@ -86,9 +86,9 @@ public final class ISBNCheckDigit implements CheckDigit, Serializable { * * @param code The ISBN code to validate (should have a length of * 10 or 13) - * @return <code>true</code> if the code has a length of 10 and is + * @return {@code true} if the code has a length of 10 and is * a valid ISBN-10 check digit or the code has a length of 13 and is - * a valid ISBN-13 check digit - otherwise <code>false</code>. + * a valid ISBN-13 check digit - otherwise {@code false}. */ @Override public boolean isValid(final String code) { diff --git a/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusCheckDigit.java b/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusCheckDigit.java index 0d8dcdf1..50ee7a7a 100644 --- a/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusCheckDigit.java +++ b/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusCheckDigit.java @@ -62,8 +62,8 @@ public abstract class ModulusCheckDigit implements CheckDigit, Serializable { * Validate a modulus check digit for a code. * * @param code The code to validate - * @return <code>true</code> if the check digit is valid, otherwise - * <code>false</code> + * @return {@code true} if the check digit is valid, otherwise + * {@code false} */ @Override public boolean isValid(final String code) { diff --git a/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusTenCheckDigit.java b/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusTenCheckDigit.java index 3f7d43ac..9c4d7839 100644 --- a/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusTenCheckDigit.java +++ b/src/main/java/org/apache/commons/validator/routines/checkdigit/ModulusTenCheckDigit.java @@ -135,7 +135,7 @@ public final class ModulusTenCheckDigit extends ModulusCheckDigit { * * @param postitionWeight the weighted values to apply based on the * character position - * @param useRightPos <code>true</code> if use positionWeights from right to + * @param useRightPos {@code true} if use positionWeights from right to * left */ public ModulusTenCheckDigit(final int[] postitionWeight, final boolean useRightPos) { @@ -149,9 +149,9 @@ public final class ModulusTenCheckDigit extends ModulusCheckDigit { * * @param postitionWeight the weighted values to apply based on the * character position - * @param useRightPos <code>true</code> if use positionWeights from right to + * @param useRightPos {@code true} if use positionWeights from right to * left - * @param sumWeightedDigits <code>true</code> if sum the digits of the + * @param sumWeightedDigits {@code true} if sum the digits of the * weighted value */ public ModulusTenCheckDigit(final int[] postitionWeight, final boolean useRightPos, final boolean sumWeightedDigits) { @@ -167,8 +167,8 @@ public final class ModulusTenCheckDigit extends ModulusCheckDigit { * Note: assumes last digit is the check digit * * @param code The code to validate - * @return <code>true</code> if the check digit is valid, otherwise - * <code>false</code> + * @return {@code true} if the check digit is valid, otherwise + * {@code false} */ @Override public boolean isValid(final String code) { diff --git a/src/main/java/org/apache/commons/validator/routines/checkdigit/VerhoeffCheckDigit.java b/src/main/java/org/apache/commons/validator/routines/checkdigit/VerhoeffCheckDigit.java index 27ccd9e5..3050f3a4 100644 --- a/src/main/java/org/apache/commons/validator/routines/checkdigit/VerhoeffCheckDigit.java +++ b/src/main/java/org/apache/commons/validator/routines/checkdigit/VerhoeffCheckDigit.java @@ -69,8 +69,8 @@ public final class VerhoeffCheckDigit implements CheckDigit, Serializable { * Validate the Verhoeff <i>Check Digit</i> for a code. * * @param code The code to validate - * @return <code>true</code> if the check digit is valid, - * otherwise <code>false</code> + * @return {@code true} if the check digit is valid, + * otherwise {@code false} */ @Override public boolean isValid(final String code) { diff --git a/src/main/java/org/apache/commons/validator/routines/package-info.java b/src/main/java/org/apache/commons/validator/routines/package-info.java index 5a2becc6..0dff918a 100644 --- a/src/main/java/org/apache/commons/validator/routines/package-info.java +++ b/src/main/java/org/apache/commons/validator/routines/package-info.java @@ -480,7 +480,7 @@ * </p> * <ul> * <li><code>isValid(<i>code</i>)</code> - validates the check digit of a code, - * returning <code>true</code> or <code>false</code>.</li> + * returning {@code true} or {@code false}.</li> * <li><code>calculate(<i>code</i>)</code> - calulates the check digit for a code * returning the check digit character.</li> * </ul> @@ -605,7 +605,7 @@ * <ul> * <li><code>isValid(<i>value</i>)</code> - returns a boolean</li> * <li><code>validate(<i>value</i>)</code> - returns a reformatted ISBN code - * (converts ISBN-10 to ISBN-13 if the <i>convert</i> option is <code>true</code>).</li> + * (converts ISBN-10 to ISBN-13 if the <i>convert</i> option is {@code true}).</li> * </ul> * </li> * </ul> diff --git a/src/test/java/org/apache/commons/validator/GenericTypeValidatorImpl.java b/src/test/java/org/apache/commons/validator/GenericTypeValidatorImpl.java index 2b903652..a7f11401 100644 --- a/src/test/java/org/apache/commons/validator/GenericTypeValidatorImpl.java +++ b/src/test/java/org/apache/commons/validator/GenericTypeValidatorImpl.java @@ -32,8 +32,8 @@ public class GenericTypeValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>byte</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>byte</code> {@code true} is returned. + * Otherwise {@code false}. */ public static Byte validateByte(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -47,8 +47,8 @@ public class GenericTypeValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>byte</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>byte</code> {@code true} is returned. + * Otherwise {@code false}. */ public static Byte validateByte(final Object bean, final Field field, final Locale locale) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -62,8 +62,8 @@ public class GenericTypeValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>short</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>short</code> {@code true} is returned. + * Otherwise {@code false}. */ public static Short validateShort(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -77,8 +77,8 @@ public class GenericTypeValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>short</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>short</code> {@code true} is returned. + * Otherwise {@code false}. */ public static Short validateShort(final Object bean, final Field field, final Locale locale) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -92,8 +92,8 @@ public class GenericTypeValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>int</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>int</code> {@code true} is returned. + * Otherwise {@code false}. */ public static Integer validateInt(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -107,8 +107,8 @@ public class GenericTypeValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>int</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>int</code> {@code true} is returned. + * Otherwise {@code false}. */ public static Integer validateInt(final Object bean, final Field field, final Locale locale) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -122,8 +122,8 @@ public class GenericTypeValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>long</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>long</code> {@code true} is returned. + * Otherwise {@code false}. */ public static Long validateLong(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -137,8 +137,8 @@ public class GenericTypeValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>long</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>long</code> {@code true} is returned. + * Otherwise {@code false}. */ public static Long validateLong(final Object bean, final Field field, final Locale locale) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -152,8 +152,8 @@ public class GenericTypeValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>float</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>float</code> {@code true} is returned. + * Otherwise {@code false}. */ public static Float validateFloat(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -167,8 +167,8 @@ public class GenericTypeValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>float</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>float</code> {@code true} is returned. + * Otherwise {@code false}. */ public static Float validateFloat(final Object bean, final Field field, final Locale locale) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -182,8 +182,8 @@ public class GenericTypeValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>double</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>double</code> {@code true} is returned. + * Otherwise {@code false}. */ public static Double validateDouble(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -197,8 +197,8 @@ public class GenericTypeValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>double</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>double</code> {@code true} is returned. + * Otherwise {@code false}. */ public static Double validateDouble(final Object bean, final Field field, final Locale locale) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -212,8 +212,8 @@ public class GenericTypeValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>date</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>date</code> {@code true} is returned. + * Otherwise {@code false}. */ public static Date validateDate(final Object bean, final Field field, final Locale locale) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -227,8 +227,8 @@ public class GenericTypeValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>date</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>date</code> {@code true} is returned. + * Otherwise {@code false}. */ public static Date validateDate(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); diff --git a/src/test/java/org/apache/commons/validator/GenericValidatorImpl.java b/src/test/java/org/apache/commons/validator/GenericValidatorImpl.java index eeb8e2ac..fb08fbcb 100644 --- a/src/test/java/org/apache/commons/validator/GenericValidatorImpl.java +++ b/src/test/java/org/apache/commons/validator/GenericValidatorImpl.java @@ -58,8 +58,8 @@ public class GenericValidatorImpl { * Checks if the field is required. * * @return boolean If the field isn't <code>null</code> and - * has a length greater than zero, <code>true</code> is returned. - * Otherwise <code>false</code>. + * has a length greater than zero, {@code true} is returned. + * Otherwise {@code false}. */ public static boolean validateRequired(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -73,8 +73,8 @@ public class GenericValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>byte</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>byte</code> {@code true} is returned. + * Otherwise {@code false}. */ public static boolean validateByte(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -88,8 +88,8 @@ public class GenericValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>short</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>short</code> {@code true} is returned. + * Otherwise {@code false}. */ public static boolean validateShort(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -103,8 +103,8 @@ public class GenericValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>int</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>int</code> {@code true} is returned. + * Otherwise {@code false}. */ public static boolean validateInt(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -132,8 +132,8 @@ public class GenericValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>long</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>long</code> {@code true} is returned. + * Otherwise {@code false}. */ public static boolean validateLong(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -147,8 +147,8 @@ public class GenericValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>float</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>float</code> {@code true} is returned. + * Otherwise {@code false}. */ public static boolean validateFloat(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -162,8 +162,8 @@ public class GenericValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field can be successfully converted - * to a <code>double</code> <code>true</code> is returned. - * Otherwise <code>false</code>. + * to a <code>double</code> {@code true} is returned. + * Otherwise {@code false}. */ public static boolean validateDouble(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -177,8 +177,8 @@ public class GenericValidatorImpl { * @param bean The value validation is being performed on. * @param field the field to use * @return boolean If the field is an e-mail address - * <code>true</code> is returned. - * Otherwise <code>false</code>. + * {@code true} is returned. + * Otherwise {@code false}. */ public static boolean validateEmail(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty());