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 114ce504 Javadoc: Use {@code ...} 114ce504 is described below commit 114ce5049493ef3464a7bad7b2b8e1db2f654dff Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Wed Jan 17 09:29:47 2024 -0500 Javadoc: Use {@code ...} --- .../apache/commons/validator/EmailValidator.java | 2 +- .../java/org/apache/commons/validator/Field.java | 2 +- .../apache/commons/validator/ISBNValidator.java | 2 +- .../org/apache/commons/validator/UrlValidator.java | 8 ++++---- .../org/apache/commons/validator/Validator.java | 2 +- .../apache/commons/validator/ValidatorAction.java | 2 +- .../routines/AbstractCalendarValidator.java | 8 ++++---- .../routines/AbstractFormatValidator.java | 6 +++--- .../routines/AbstractNumberValidator.java | 10 ++++----- .../validator/routines/BigDecimalValidator.java | 12 +++++------ .../validator/routines/BigIntegerValidator.java | 10 ++++----- .../commons/validator/routines/ByteValidator.java | 12 +++++------ .../validator/routines/CalendarValidator.java | 20 +++++++++--------- .../commons/validator/routines/CodeValidator.java | 4 ++-- .../validator/routines/CreditCardValidator.java | 2 +- .../validator/routines/CurrencyValidator.java | 2 +- .../commons/validator/routines/DateValidator.java | 24 +++++++++++----------- .../validator/routines/DoubleValidator.java | 12 +++++------ .../commons/validator/routines/EmailValidator.java | 2 +- .../commons/validator/routines/FloatValidator.java | 12 +++++------ .../commons/validator/routines/ISBNValidator.java | 10 ++++----- .../commons/validator/routines/ISINValidator.java | 2 +- .../commons/validator/routines/ISSNValidator.java | 8 ++++---- .../validator/routines/IntegerValidator.java | 12 +++++------ .../commons/validator/routines/LongValidator.java | 10 ++++----- .../validator/routines/PercentValidator.java | 2 +- .../commons/validator/routines/RegexValidator.java | 4 ++-- .../commons/validator/routines/ShortValidator.java | 12 +++++------ .../commons/validator/routines/TimeValidator.java | 20 +++++++++--------- .../commons/validator/routines/UrlValidator.java | 8 ++++---- .../commons/validator/routines/package-info.java | 4 ++-- .../commons/validator/util/ValidatorUtils.java | 2 +- .../commons/validator/GenericValidatorImpl.java | 2 +- .../apache/commons/validator/ValidatorTest.java | 4 ++-- 34 files changed, 127 insertions(+), 127 deletions(-) diff --git a/src/main/java/org/apache/commons/validator/EmailValidator.java b/src/main/java/org/apache/commons/validator/EmailValidator.java index 4c9e57c5..55a29138 100644 --- a/src/main/java/org/apache/commons/validator/EmailValidator.java +++ b/src/main/java/org/apache/commons/validator/EmailValidator.java @@ -80,7 +80,7 @@ public class EmailValidator { /** * <p>Checks if a field has a valid e-mail address.</p> * - * @param email The value validation is being performed on. A <code>null</code> + * @param email The value validation is being performed on. A {@code null} * value is considered invalid. * @return true if the email address is valid. */ diff --git a/src/main/java/org/apache/commons/validator/Field.java b/src/main/java/org/apache/commons/validator/Field.java index 800ff784..cf10b809 100644 --- a/src/main/java/org/apache/commons/validator/Field.java +++ b/src/main/java/org/apache/commons/validator/Field.java @@ -313,7 +313,7 @@ public class Field implements Cloneable, Serializable { /** * Gets the <code>Arg</code> object at the given position. If the key - * finds a <code>null</code> value then the default value will be + * finds a {@code null} value then the default value will be * retrieved. * @param key The name the Arg is stored under. If not found, the default * Arg for the given position (if any) will be retrieved. diff --git a/src/main/java/org/apache/commons/validator/ISBNValidator.java b/src/main/java/org/apache/commons/validator/ISBNValidator.java index 5cfeec44..665cd3b5 100644 --- a/src/main/java/org/apache/commons/validator/ISBNValidator.java +++ b/src/main/java/org/apache/commons/validator/ISBNValidator.java @@ -43,7 +43,7 @@ public class ISBNValidator { * divided by 11 according to the ISBN algorithm. If the result is zero, * the ISBN is valid. This method accepts formatted or raw ISBN codes. * - * @param isbn Candidate ISBN number to be validated. <code>null</code> is + * @param isbn Candidate ISBN number to be validated. {@code null} is * considered invalid. * @return true if the string is a valid ISBN code. */ diff --git a/src/main/java/org/apache/commons/validator/UrlValidator.java b/src/main/java/org/apache/commons/validator/UrlValidator.java index a2b464ee..ee918eea 100644 --- a/src/main/java/org/apache/commons/validator/UrlValidator.java +++ b/src/main/java/org/apache/commons/validator/UrlValidator.java @@ -254,7 +254,7 @@ public class UrlValidator implements Serializable { /** * <p>Checks if a field has a valid URL address.</p> * - * @param value The value validation is being performed on. A <code>null</code> + * @param value The value validation is being performed on. A {@code null} * value is considered invalid. * @return true if the URL is valid. */ @@ -297,7 +297,7 @@ public class UrlValidator implements Serializable { /** * Returns true if the authority is properly formatted. An authority is the combination - * of hostname and port. A <code>null</code> authority value is considered invalid. + * of hostname and port. A {@code null} authority value is considered invalid. * @param authority Authority value to validate. * @return true if authority (hostname and port) is valid. */ @@ -401,7 +401,7 @@ public class UrlValidator implements Serializable { } /** - * Returns true if the path is valid. A <code>null</code> value is considered invalid. + * Returns true if the path is valid. A {@code null} value is considered invalid. * @param path Path value to validate. * @return true if path is valid. */ @@ -445,7 +445,7 @@ public class UrlValidator implements Serializable { * Validate scheme. If schemes[] was initialized to a non null, * then only those scheme's are allowed. Note this is slightly different * than for the constructor. - * @param scheme The scheme to validate. A <code>null</code> value is considered + * @param scheme The scheme to validate. A {@code null} value is considered * invalid. * @return true if valid. */ diff --git a/src/main/java/org/apache/commons/validator/Validator.java b/src/main/java/org/apache/commons/validator/Validator.java index 91994afb..262aecd1 100644 --- a/src/main/java/org/apache/commons/validator/Validator.java +++ b/src/main/java/org/apache/commons/validator/Validator.java @@ -281,7 +281,7 @@ public class Validator implements Serializable { * Sets the class loader to be used for instantiating application objects * when required. * - * @param classLoader The new class loader to use, or <code>null</code> + * @param classLoader The new class loader to use, or {@code null} * to revert to the standard rules */ public void setClassLoader(final ClassLoader classLoader) { diff --git a/src/main/java/org/apache/commons/validator/ValidatorAction.java b/src/main/java/org/apache/commons/validator/ValidatorAction.java index e78b8421..b2caa59c 100644 --- a/src/main/java/org/apache/commons/validator/ValidatorAction.java +++ b/src/main/java/org/apache/commons/validator/ValidatorAction.java @@ -423,7 +423,7 @@ 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} if the object is <code>null</code> and + * If the result object is a <code>Boolean</code>, it will return its value. If not it will return {@code false} if the object is {@code null} and * {@code true} if it isn't. */ private boolean isValid(final Object result) { 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 841caf73..324a5707 100644 --- a/src/main/java/org/apache/commons/validator/routines/AbstractCalendarValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/AbstractCalendarValidator.java @@ -361,7 +361,7 @@ public abstract class AbstractCalendarValidator extends AbstractFormatValidator * and/or <code>Locale</code>.</p> * * @param pattern The pattern used to validate the value against or - * <code>null</code> to use the default for the <code>Locale</code>. + * {@code null} to use the default for the <code>Locale</code>. * @param locale The locale to use for the currency format, system default if null. * @return The <code>DateFormat</code> to created. */ @@ -400,10 +400,10 @@ public abstract class AbstractCalendarValidator extends AbstractFormatValidator * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. * @param timeZone The Time Zone used to parse the date, system default if null. - * @return The parsed value if valid or <code>null</code> if invalid. + * @return The parsed value if valid or {@code null} if invalid. */ protected Object parse(String value, final String pattern, final Locale locale, final TimeZone timeZone) { @@ -426,7 +426,7 @@ public abstract class AbstractCalendarValidator extends AbstractFormatValidator * @param value The parsed object created. * @param formatter The Format used to parse the value with. * @return The parsed value converted to the appropriate type - * if valid or <code>null</code> if invalid. + * if valid or {@code null} if invalid. */ @Override protected abstract Object processParsedValue(Object value, Format formatter); 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 827ea709..6797a345 100644 --- a/src/main/java/org/apache/commons/validator/routines/AbstractFormatValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/AbstractFormatValidator.java @@ -113,7 +113,7 @@ public abstract class AbstractFormatValidator implements Serializable { * and/or <code>Locale</code>.</p> * * @param pattern The pattern used to validate the value against or - * <code>null</code> to use the default for the <code>Locale</code>. + * {@code null} to use the default for the <code>Locale</code>. * @param locale The locale to use for the currency format, system default if null. * @return The <code>NumberFormat</code> to created. */ @@ -187,7 +187,7 @@ public abstract class AbstractFormatValidator implements Serializable { * * @param value The value to be parsed. * @param formatter The Format to parse the value with. - * @return The parsed value if valid or <code>null</code> if invalid. + * @return The parsed value if valid or {@code null} if invalid. */ protected Object parse(final String value, final Format formatter) { @@ -216,7 +216,7 @@ public abstract class AbstractFormatValidator implements Serializable { * @param value The parsed object created. * @param formatter The Format used to parse the value with. * @return The parsed value converted to the appropriate type - * if valid or <code>null</code> if invalid. + * if valid or {@code null} if invalid. */ protected abstract Object processParsedValue(Object value, Format formatter); 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 9c4d7ea5..e2dc0f1c 100644 --- a/src/main/java/org/apache/commons/validator/routines/AbstractNumberValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/AbstractNumberValidator.java @@ -146,7 +146,7 @@ public abstract class AbstractNumberValidator extends AbstractFormatValidator { * and/or <code>Locale</code>.</p> * * @param pattern The pattern used to validate the value against or - * <code>null</code> to use the default for the <code>Locale</code>. + * {@code null} to use the default for the <code>Locale</code>. * @param locale The locale to use for the currency format, system default if null. * @return The <code>NumberFormat</code> to created. */ @@ -209,7 +209,7 @@ public abstract class AbstractNumberValidator extends AbstractFormatValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. * @return {@code true} if the value is valid. */ @@ -254,9 +254,9 @@ public abstract class AbstractNumberValidator extends AbstractFormatValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. - * @return The parsed value if valid or <code>null</code> if invalid. + * @return The parsed value if valid or {@code null} if invalid. */ protected Object parse(String value, final String pattern, final Locale locale) { value = value == null ? null : value.trim(); @@ -275,7 +275,7 @@ public abstract class AbstractNumberValidator extends AbstractFormatValidator { * @param value The parsed object created. * @param formatter The Format used to parse the value with. * @return The parsed value converted to the appropriate type - * if valid or <code>null</code> if invalid. + * if valid or {@code null} if invalid. */ @Override protected abstract Object processParsedValue(Object value, Format formatter); 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 c98c505e..f521ab4e 100644 --- a/src/main/java/org/apache/commons/validator/routines/BigDecimalValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/BigDecimalValidator.java @@ -191,7 +191,7 @@ public class BigDecimalValidator extends AbstractNumberValidator { * <code>Locale</code>. * * @param value The value validation is being performed on. - * @return The parsed <code>BigDecimal</code> if valid or <code>null</code> + * @return The parsed <code>BigDecimal</code> if valid or {@code null} * if invalid. */ public BigDecimal validate(final String value) { @@ -204,7 +204,7 @@ public class BigDecimalValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param locale The locale to use for the number format, system default if null. - * @return The parsed <code>BigDecimal</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>BigDecimal</code> if valid or {@code null} if invalid. */ public BigDecimal validate(final String value, final Locale locale) { return (BigDecimal)parse(value, (String)null, locale); @@ -216,8 +216,8 @@ public class BigDecimalValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. - * @return The parsed <code>BigDecimal</code> if valid or <code>null</code> if invalid. + * default for the <code>Locale</code> if {@code null}. + * @return The parsed <code>BigDecimal</code> if valid or {@code null} if invalid. */ public BigDecimal validate(final String value, final String pattern) { return (BigDecimal)parse(value, pattern, (Locale)null); @@ -229,9 +229,9 @@ public class BigDecimalValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. - * @return The parsed <code>BigDecimal</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>BigDecimal</code> if valid or {@code null} if invalid. */ public BigDecimal validate(final String value, final String pattern, final Locale locale) { return (BigDecimal)parse(value, pattern, locale); 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 1b9a3489..45c5157a 100644 --- a/src/main/java/org/apache/commons/validator/routines/BigIntegerValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/BigIntegerValidator.java @@ -163,7 +163,7 @@ public class BigIntegerValidator extends AbstractNumberValidator { * <code>Locale</code>. * * @param value The value validation is being performed on. - * @return The parsed <code>BigInteger</code> if valid or <code>null</code> + * @return The parsed <code>BigInteger</code> if valid or {@code null} * if invalid. */ public BigInteger validate(final String value) { @@ -176,7 +176,7 @@ public class BigIntegerValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param locale The locale to use for the number format, system default if null. - * @return The parsed <code>BigInteger</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>BigInteger</code> if valid or {@code null} if invalid. */ public BigInteger validate(final String value, final Locale locale) { return (BigInteger)parse(value, (String)null, locale); @@ -188,7 +188,7 @@ public class BigIntegerValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against. - * @return The parsed <code>BigInteger</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>BigInteger</code> if valid or {@code null} if invalid. */ public BigInteger validate(final String value, final String pattern) { return (BigInteger)parse(value, pattern, (Locale)null); @@ -200,9 +200,9 @@ public class BigIntegerValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. - * @return The parsed <code>BigInteger</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>BigInteger</code> if valid or {@code null} if invalid. */ public BigInteger validate(final String value, final String pattern, final Locale locale) { return (BigInteger)parse(value, pattern, locale); 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 96be9918..63869ae4 100644 --- a/src/main/java/org/apache/commons/validator/routines/ByteValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/ByteValidator.java @@ -188,7 +188,7 @@ public class ByteValidator extends AbstractNumberValidator { * @param value The parsed <code>Number</code> object created. * @param formatter The Format used to parse the value with. * @return The parsed <code>Number</code> converted to a - * <code>Byte</code> if valid or <code>null</code> if invalid. + * <code>Byte</code> if valid or {@code null} if invalid. */ @Override protected Object processParsedValue(final Object value, final Format formatter) { @@ -209,7 +209,7 @@ public class ByteValidator extends AbstractNumberValidator { * <code>Locale</code>. * * @param value The value validation is being performed on. - * @return The parsed <code>Byte</code> if valid or <code>null</code> + * @return The parsed <code>Byte</code> if valid or {@code null} * if invalid. */ public Byte validate(final String value) { @@ -222,7 +222,7 @@ public class ByteValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param locale The locale to use for the number format, system default if null. - * @return The parsed <code>Byte</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Byte</code> if valid or {@code null} if invalid. */ public Byte validate(final String value, final Locale locale) { return (Byte)parse(value, (String)null, locale); @@ -234,7 +234,7 @@ public class ByteValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against. - * @return The parsed <code>Byte</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Byte</code> if valid or {@code null} if invalid. */ public Byte validate(final String value, final String pattern) { return (Byte)parse(value, pattern, (Locale)null); @@ -246,9 +246,9 @@ public class ByteValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. - * @return The parsed <code>Byte</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Byte</code> if valid or {@code null} if invalid. */ public Byte validate(final String value, final String pattern, final Locale locale) { return (Byte)parse(value, pattern, locale); 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 08d5c8a0..5f09d0bd 100644 --- a/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/CalendarValidator.java @@ -235,7 +235,7 @@ public class CalendarValidator extends AbstractCalendarValidator { * <code>Locale</code> and <code>TimeZone</code>. * * @param value The value validation is being performed on. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> + * @return The parsed <code>Calendar</code> if valid or {@code null} * if invalid. */ public Calendar validate(final String value) { @@ -248,7 +248,7 @@ public class CalendarValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param locale The locale to use for the date format, system default if null. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Calendar</code> if valid or {@code null} if invalid. */ public Calendar validate(final String value, final Locale locale) { return (Calendar)parse(value, (String)null, locale, (TimeZone)null); @@ -261,7 +261,7 @@ public class CalendarValidator extends AbstractCalendarValidator { * @param value The value validation is being performed on. * @param locale The locale to use for the date format, system default if null. * @param timeZone The Time Zone used to parse the date, system default if null. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Calendar</code> if valid or {@code null} if invalid. */ public Calendar validate(final String value, final Locale locale, final TimeZone timeZone) { return (Calendar)parse(value, (String)null, locale, timeZone); @@ -273,7 +273,7 @@ public class CalendarValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Calendar</code> if valid or {@code null} if invalid. */ public Calendar validate(final String value, final String pattern) { return (Calendar)parse(value, pattern, (Locale)null, (TimeZone)null); @@ -285,9 +285,9 @@ public class CalendarValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Calendar</code> if valid or {@code null} if invalid. */ public Calendar validate(final String value, final String pattern, final Locale locale) { return (Calendar)parse(value, pattern, locale, (TimeZone)null); @@ -299,10 +299,10 @@ public class CalendarValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. * @param timeZone The Time Zone used to parse the date, system default if null. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Calendar</code> if valid or {@code null} if invalid. */ public Calendar validate(final String value, final String pattern, final Locale locale, final TimeZone timeZone) { return (Calendar)parse(value, pattern, locale, timeZone); @@ -315,7 +315,7 @@ public class CalendarValidator extends AbstractCalendarValidator { * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against. * @param timeZone The Time Zone used to parse the date, system default if null. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Calendar</code> if valid or {@code null} if invalid. */ public Calendar validate(final String value, final String pattern, final TimeZone timeZone) { return (Calendar)parse(value, pattern, (Locale)null, timeZone); @@ -327,7 +327,7 @@ public class CalendarValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param timeZone The Time Zone used to parse the date, system default if null. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> + * @return The parsed <code>Calendar</code> if valid or {@code null} * if invalid. */ public Calendar validate(final String value, final TimeZone timeZone) { 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 f2d6b7bb..e02ad8f2 100644 --- a/src/main/java/org/apache/commons/validator/routines/CodeValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/CodeValidator.java @@ -242,14 +242,14 @@ public final class CodeValidator implements Serializable { /** * Validate the code returning either the valid code or - * <code>null</code> if invalid. + * {@code null} if invalid. * <p> * Note that this method trims the input * and if there is a {@link RegexValidator} it may also * change the input as part of the validation. * * @param input The code to validate - * @return The code if valid, otherwise <code>null</code> + * @return The code if valid, otherwise {@code null} * if invalid */ public Object validate(final String input) { diff --git a/src/main/java/org/apache/commons/validator/routines/CreditCardValidator.java b/src/main/java/org/apache/commons/validator/routines/CreditCardValidator.java index 1630b432..98868e5a 100644 --- a/src/main/java/org/apache/commons/validator/routines/CreditCardValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/CreditCardValidator.java @@ -504,7 +504,7 @@ public class CreditCardValidator implements Serializable { /** * Checks if the field is a valid credit card number. * @param card The card number to validate. - * @return The card number if valid or <code>null</code> + * @return The card number if valid or {@code null} * if invalid. */ public Object validate(final String card) { 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 87a2e4e4..f88ce052 100644 --- a/src/main/java/org/apache/commons/validator/routines/CurrencyValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/CurrencyValidator.java @@ -88,7 +88,7 @@ public class CurrencyValidator extends BigDecimalValidator { * * @param value The value to be parsed. * @param formatter The Format to parse the value with. - * @return The parsed value if valid or <code>null</code> if invalid. + * @return The parsed value if valid or {@code null} if invalid. */ @Override protected Object parse(final String value, final Format formatter) { 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 8562b206..90c4328e 100644 --- a/src/main/java/org/apache/commons/validator/routines/DateValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/DateValidator.java @@ -246,7 +246,7 @@ public class DateValidator extends AbstractCalendarValidator { * <code>Locale</code> and <code>TimeZone</code>. * * @param value The value validation is being performed on. - * @return The parsed <code>Date</code> if valid or <code>null</code> + * @return The parsed <code>Date</code> if valid or {@code null} * if invalid. */ public Date validate(final String value) { @@ -259,7 +259,7 @@ public class DateValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param locale The locale to use for the date format, system default if null. - * @return The parsed <code>Date</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Date</code> if valid or {@code null} if invalid. */ public Date validate(final String value, final Locale locale) { return (Date)parse(value, (String)null, locale, (TimeZone)null); @@ -272,7 +272,7 @@ public class DateValidator extends AbstractCalendarValidator { * @param value The value validation is being performed on. * @param locale The locale to use for the date format, system default if null. * @param timeZone The Time Zone used to parse the date, system default if null. - * @return The parsed <code>Date</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Date</code> if valid or {@code null} if invalid. */ public Date validate(final String value, final Locale locale, final TimeZone timeZone) { return (Date)parse(value, (String)null, locale, timeZone); @@ -284,8 +284,8 @@ public class DateValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. - * @return The parsed <code>Date</code> if valid or <code>null</code> if invalid. + * default for the <code>Locale</code> if {@code null}. + * @return The parsed <code>Date</code> if valid or {@code null} if invalid. */ public Date validate(final String value, final String pattern) { return (Date)parse(value, pattern, (Locale)null, (TimeZone)null); @@ -297,9 +297,9 @@ public class DateValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. - * @return The parsed <code>Date</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Date</code> if valid or {@code null} if invalid. */ public Date validate(final String value, final String pattern, final Locale locale) { return (Date)parse(value, pattern, locale, (TimeZone)null); @@ -311,10 +311,10 @@ public class DateValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. * @param timeZone The Time Zone used to parse the date, system default if null. - * @return The parsed <code>Date</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Date</code> if valid or {@code null} if invalid. */ public Date validate(final String value, final String pattern, final Locale locale, final TimeZone timeZone) { return (Date)parse(value, pattern, locale, timeZone); @@ -326,9 +326,9 @@ public class DateValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param timeZone The Time Zone used to parse the date, system default if null. - * @return The parsed <code>Date</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Date</code> if valid or {@code null} if invalid. */ public Date validate(final String value, final String pattern, final TimeZone timeZone) { return (Date)parse(value, pattern, (Locale)null, timeZone); @@ -340,7 +340,7 @@ public class DateValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param timeZone The Time Zone used to parse the date, system default if null. - * @return The parsed <code>Date</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Date</code> if valid or {@code null} if invalid. */ public Date validate(final String value, final TimeZone timeZone) { return (Date)parse(value, (String)null, (Locale)null, timeZone); 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 428ebd07..8702da4a 100644 --- a/src/main/java/org/apache/commons/validator/routines/DoubleValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/DoubleValidator.java @@ -187,7 +187,7 @@ public class DoubleValidator extends AbstractNumberValidator { * @param value The parsed <code>Number</code> object created. * @param formatter The Format used to parse the value with. * @return The validated/converted <code>Double</code> value if valid - * or <code>null</code> if invalid. + * or {@code null} if invalid. */ @Override protected Object processParsedValue(final Object value, final Format formatter) { @@ -204,7 +204,7 @@ public class DoubleValidator extends AbstractNumberValidator { * <code>Locale</code>. * * @param value The value validation is being performed on. - * @return The parsed <code>Double</code> if valid or <code>null</code> + * @return The parsed <code>Double</code> if valid or {@code null} * if invalid. */ public Double validate(final String value) { @@ -217,7 +217,7 @@ public class DoubleValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param locale The locale to use for the number format, system default if null. - * @return The parsed <code>Double</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Double</code> if valid or {@code null} if invalid. */ public Double validate(final String value, final Locale locale) { return (Double)parse(value, (String)null, locale); @@ -229,7 +229,7 @@ public class DoubleValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against. - * @return The parsed <code>BigDecimal</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>BigDecimal</code> if valid or {@code null} if invalid. */ public Double validate(final String value, final String pattern) { return (Double)parse(value, pattern, (Locale)null); @@ -241,9 +241,9 @@ public class DoubleValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. - * @return The parsed <code>Double</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Double</code> if valid or {@code null} if invalid. */ public Double validate(final String value, final String pattern, final Locale locale) { return (Double)parse(value, pattern, locale); diff --git a/src/main/java/org/apache/commons/validator/routines/EmailValidator.java b/src/main/java/org/apache/commons/validator/routines/EmailValidator.java index 3cf1f7c1..d370d080 100644 --- a/src/main/java/org/apache/commons/validator/routines/EmailValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/EmailValidator.java @@ -163,7 +163,7 @@ public class EmailValidator implements Serializable { /** * <p>Checks if a field has a valid e-mail address.</p> * - * @param email The value validation is being performed on. A <code>null</code> + * @param email The value validation is being performed on. A {@code null} * value is considered invalid. * @return true if the email address is valid. */ 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 999184cd..ed1c67c9 100644 --- a/src/main/java/org/apache/commons/validator/routines/FloatValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/FloatValidator.java @@ -188,7 +188,7 @@ public class FloatValidator extends AbstractNumberValidator { * @param value The parsed <code>Number</code> object created. * @param formatter The Format used to parse the value with. * @return The parsed <code>Number</code> converted to a - * <code>Float</code> if valid or <code>null</code> if invalid. + * <code>Float</code> if valid or {@code null} if invalid. */ @Override protected Object processParsedValue(final Object value, final Format formatter) { @@ -221,7 +221,7 @@ public class FloatValidator extends AbstractNumberValidator { * <code>Locale</code>. * * @param value The value validation is being performed on. - * @return The parsed <code>Float</code> if valid or <code>null</code> + * @return The parsed <code>Float</code> if valid or {@code null} * if invalid. */ public Float validate(final String value) { @@ -234,7 +234,7 @@ public class FloatValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param locale The locale to use for the number format, system default if null. - * @return The parsed <code>Float</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Float</code> if valid or {@code null} if invalid. */ public Float validate(final String value, final Locale locale) { return (Float)parse(value, (String)null, locale); @@ -246,7 +246,7 @@ public class FloatValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against. - * @return The parsed <code>Float</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Float</code> if valid or {@code null} if invalid. */ public Float validate(final String value, final String pattern) { return (Float)parse(value, pattern, (Locale)null); @@ -258,9 +258,9 @@ public class FloatValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. - * @return The parsed <code>Float</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Float</code> if valid or {@code null} if invalid. */ public Float validate(final String value, final String pattern, final Locale locale) { return (Float)parse(value, pattern, locale); 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 8f07c624..e0229ee9 100644 --- a/src/main/java/org/apache/commons/validator/routines/ISBNValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/ISBNValidator.java @@ -31,7 +31,7 @@ import org.apache.commons.validator.routines.checkdigit.ISBN10CheckDigit; * the {@link EAN13CheckDigit} routine). * <p> * The <code>validate()</code> methods return the ISBN code with formatting - * characters removed if valid or <code>null</code> if invalid. + * characters removed if valid or {@code null} 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}. @@ -153,7 +153,7 @@ public class ISBNValidator implements Serializable { * characters. * * @param isbn10 The ISBN-10 code to convert - * @return A converted ISBN-13 code or <code>null</code> + * @return A converted ISBN-13 code or {@code null} * if the ISBN-10 code is not valid */ public String convertToISBN13(final String isbn10) { @@ -222,7 +222,7 @@ public class ISBNValidator implements Serializable { * <code>convertToISBN13</code> is {@code true}. * * @param code The code to validate. - * @return A valid ISBN code if valid, otherwise <code>null</code>. + * @return A valid ISBN code if valid, otherwise {@code null}. */ public String validate(final String code) { String result = validateISBN13(code); @@ -243,7 +243,7 @@ public class ISBNValidator implements Serializable { * * @param code The code to validate. * @return A valid ISBN-10 code if valid, - * otherwise <code>null</code>. + * otherwise {@code null}. */ public String validateISBN10(final String code) { final Object result = isbn10Validator.validate(code); @@ -258,7 +258,7 @@ public class ISBNValidator implements Serializable { * * @param code The code to validate. * @return A valid ISBN-13 code if valid, - * otherwise <code>null</code>. + * otherwise {@code null}. */ public String validateISBN13(final String code) { final Object result = isbn13Validator.validate(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 a0c0f354..6e379f6e 100644 --- a/src/main/java/org/apache/commons/validator/routines/ISINValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/ISINValidator.java @@ -111,7 +111,7 @@ public class ISINValidator implements Serializable { * Check the code is valid ISIN code. * * @param code The code to validate. - * @return A valid ISIN code if valid, otherwise <code>null</code>. + * @return A valid ISIN code if valid, otherwise {@code null}. */ public Object validate(final String code) { final Object validate = VALIDATOR.validate(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 4080a9b6..53c49ec7 100644 --- a/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/ISSNValidator.java @@ -100,7 +100,7 @@ public class ISSNValidator implements Serializable { * * @param issn The ISSN code to convert * @param suffix the two digit suffix, e.g. "00" - * @return A converted EAN-13 code or <code>null</code> + * @return A converted EAN-13 code or {@code null} * if the input ISSN code is not valid */ public String convertToEAN13(final String issn, final String suffix) { @@ -135,7 +135,7 @@ public class ISSNValidator implements Serializable { * That is a 13 digit EAN-13 code with the '977' prefix * * @param ean13 The ISSN code to convert - * @return A valid ISSN code or <code>null</code> + * @return A valid ISSN code or {@code null} * if the input ISSN EAN-13 code is not valid * @since 1.7 */ @@ -183,7 +183,7 @@ public class ISSNValidator implements Serializable { * the 'ISSN ' prefix removed (if it was present) * * @param code The code to validate. - * @return A valid ISSN code if valid, otherwise <code>null</code>. + * @return A valid ISSN code if valid, otherwise {@code null}. */ public Object validate(final String code) { return VALIDATOR.validate(code); @@ -195,7 +195,7 @@ public class ISSNValidator implements Serializable { * If valid, this method returns the EAN code * * @param code The code to validate. - * @return A valid EAN code if valid, otherwise <code>null</code>. + * @return A valid EAN code if valid, otherwise {@code null}. * @since 1.7 */ public Object validateEan(final String 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 7c09432a..11b3b113 100644 --- a/src/main/java/org/apache/commons/validator/routines/IntegerValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/IntegerValidator.java @@ -188,7 +188,7 @@ public class IntegerValidator extends AbstractNumberValidator { * @param value The parsed <code>Number</code> object created. * @param formatter The Format used to parse the value with. * @return The parsed <code>Number</code> converted to an - * <code>Integer</code> if valid or <code>null</code> if invalid. + * <code>Integer</code> if valid or {@code null} if invalid. */ @Override protected Object processParsedValue(final Object value, final Format formatter) { @@ -209,7 +209,7 @@ public class IntegerValidator extends AbstractNumberValidator { * <code>Locale</code>. * * @param value The value validation is being performed on. - * @return The parsed <code>Integer</code> if valid or <code>null</code> + * @return The parsed <code>Integer</code> if valid or {@code null} * if invalid. */ public Integer validate(final String value) { @@ -222,7 +222,7 @@ public class IntegerValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param locale The locale to use for the number format, system default if null. - * @return The parsed <code>Integer</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Integer</code> if valid or {@code null} if invalid. */ public Integer validate(final String value, final Locale locale) { return (Integer)parse(value, (String)null, locale); @@ -234,7 +234,7 @@ public class IntegerValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against. - * @return The parsed <code>Integer</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Integer</code> if valid or {@code null} if invalid. */ public Integer validate(final String value, final String pattern) { return (Integer)parse(value, pattern, (Locale)null); @@ -246,9 +246,9 @@ public class IntegerValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. - * @return The parsed <code>Integer</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Integer</code> if valid or {@code null} if invalid. */ public Integer validate(final String value, final String pattern, final Locale locale) { return (Integer)parse(value, pattern, locale); 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 4f59ba2d..09c9d523 100644 --- a/src/main/java/org/apache/commons/validator/routines/LongValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/LongValidator.java @@ -204,7 +204,7 @@ public class LongValidator extends AbstractNumberValidator { * <code>Locale</code>. * * @param value The value validation is being performed on. - * @return The parsed <code>Long</code> if valid or <code>null</code> + * @return The parsed <code>Long</code> if valid or {@code null} * if invalid. */ public Long validate(final String value) { @@ -217,7 +217,7 @@ public class LongValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param locale The locale to use for the number format, system default if null. - * @return The parsed <code>Long</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Long</code> if valid or {@code null} if invalid. */ public Long validate(final String value, final Locale locale) { return (Long)parse(value, (String)null, locale); @@ -229,7 +229,7 @@ public class LongValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against. - * @return The parsed <code>Long</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Long</code> if valid or {@code null} if invalid. */ public Long validate(final String value, final String pattern) { return (Long)parse(value, pattern, (Locale)null); @@ -241,9 +241,9 @@ public class LongValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. - * @return The parsed <code>Long</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Long</code> if valid or {@code null} if invalid. */ public Long validate(final String value, final String pattern, final Locale locale) { return (Long)parse(value, pattern, locale); 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 d1262bf1..343cad1a 100644 --- a/src/main/java/org/apache/commons/validator/routines/PercentValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/PercentValidator.java @@ -91,7 +91,7 @@ public class PercentValidator extends BigDecimalValidator { * * @param value The value to be parsed. * @param formatter The Format to parse the value with. - * @return The parsed value if valid or <code>null</code> if invalid. + * @return The parsed value if valid or {@code null} if invalid. */ @Override protected Object parse(final String value, final Format formatter) { 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 a12437c3..7b623196 100644 --- a/src/main/java/org/apache/commons/validator/routines/RegexValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/RegexValidator.java @@ -177,7 +177,7 @@ public class RegexValidator implements Serializable { * * @param value The value to validate. * @return String array of the <i>groups</i> matched if - * valid or <code>null</code> if invalid + * valid or {@code null} if invalid */ public String[] match(final String value) { if (value == null) { @@ -221,7 +221,7 @@ public class RegexValidator implements Serializable { * * @param value The value to validate. * @return Aggregated String value comprised of the - * <i>groups</i> matched if valid or <code>null</code> if invalid + * <i>groups</i> matched if valid or {@code null} if invalid */ public String validate(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 24a64ef7..34626185 100644 --- a/src/main/java/org/apache/commons/validator/routines/ShortValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/ShortValidator.java @@ -188,7 +188,7 @@ public class ShortValidator extends AbstractNumberValidator { * @param value The parsed <code>Number</code> object created. * @param formatter The Format used to parse the value with. * @return The parsed <code>Number</code> converted to a - * <code>Short</code> if valid or <code>null</code> if invalid. + * <code>Short</code> if valid or {@code null} if invalid. */ @Override protected Object processParsedValue(final Object value, final Format formatter) { @@ -207,7 +207,7 @@ public class ShortValidator extends AbstractNumberValidator { * <code>Locale</code>. * * @param value The value validation is being performed on. - * @return The parsed <code>Short</code> if valid or <code>null</code> + * @return The parsed <code>Short</code> if valid or {@code null} * if invalid. */ public Short validate(final String value) { @@ -220,7 +220,7 @@ public class ShortValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param locale The locale to use for the number format, system default if null. - * @return The parsed <code>Short</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Short</code> if valid or {@code null} if invalid. */ public Short validate(final String value, final Locale locale) { return (Short)parse(value, (String)null, locale); @@ -232,7 +232,7 @@ public class ShortValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against. - * @return The parsed <code>Short</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Short</code> if valid or {@code null} if invalid. */ public Short validate(final String value, final String pattern) { return (Short)parse(value, pattern, (Locale)null); @@ -244,9 +244,9 @@ public class ShortValidator extends AbstractNumberValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. - * @return The parsed <code>Short</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Short</code> if valid or {@code null} if invalid. */ public Short validate(final String value, final String pattern, final Locale locale) { return (Short)parse(value, pattern, locale); 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 474a22c0..90148b3f 100644 --- a/src/main/java/org/apache/commons/validator/routines/TimeValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/TimeValidator.java @@ -184,7 +184,7 @@ public class TimeValidator extends AbstractCalendarValidator { * and <code>TimeZone</code>. * * @param value The value validation is being performed on. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> + * @return The parsed <code>Calendar</code> if valid or {@code null} * if invalid. */ public Calendar validate(final String value) { @@ -197,7 +197,7 @@ public class TimeValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param locale The locale to use for the time format, system default if null. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Calendar</code> if valid or {@code null} if invalid. */ public Calendar validate(final String value, final Locale locale) { return (Calendar)parse(value, (String)null, locale, (TimeZone)null); @@ -210,7 +210,7 @@ public class TimeValidator extends AbstractCalendarValidator { * @param value The value validation is being performed on. * @param locale The locale to use for the time format, system default if null. * @param timeZone The Time Zone used to parse the time, system default if null. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Calendar</code> if valid or {@code null} if invalid. */ public Calendar validate(final String value, final Locale locale, final TimeZone timeZone) { return (Calendar)parse(value, (String)null, locale, timeZone); @@ -222,7 +222,7 @@ public class TimeValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Calendar</code> if valid or {@code null} if invalid. */ public Calendar validate(final String value, final String pattern) { return (Calendar)parse(value, pattern, (Locale)null, (TimeZone)null); @@ -234,9 +234,9 @@ public class TimeValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Calendar</code> if valid or {@code null} if invalid. */ public Calendar validate(final String value, final String pattern, final Locale locale) { return (Calendar)parse(value, pattern, locale, (TimeZone)null); @@ -248,10 +248,10 @@ public class TimeValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against, or the - * default for the <code>Locale</code> if <code>null</code>. + * default for the <code>Locale</code> if {@code null}. * @param locale The locale to use for the date format, system default if null. * @param timeZone The Time Zone used to parse the date, system default if null. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Calendar</code> if valid or {@code null} if invalid. */ public Calendar validate(final String value, final String pattern, final Locale locale, final TimeZone timeZone) { return (Calendar)parse(value, pattern, locale, timeZone); @@ -264,7 +264,7 @@ public class TimeValidator extends AbstractCalendarValidator { * @param value The value validation is being performed on. * @param pattern The pattern used to validate the value against. * @param timeZone The Time Zone used to parse the time, system default if null. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Calendar</code> if valid or {@code null} if invalid. */ public Calendar validate(final String value, final String pattern, final TimeZone timeZone) { return (Calendar)parse(value, pattern, (Locale)null, timeZone); @@ -276,7 +276,7 @@ public class TimeValidator extends AbstractCalendarValidator { * * @param value The value validation is being performed on. * @param timeZone The Time Zone used to parse the time, system default if null. - * @return The parsed <code>Calendar</code> if valid or <code>null</code> if invalid. + * @return The parsed <code>Calendar</code> if valid or {@code null} if invalid. */ public Calendar validate(final String value, final TimeZone timeZone) { return (Calendar)parse(value, (String)null, (Locale)null, timeZone); diff --git a/src/main/java/org/apache/commons/validator/routines/UrlValidator.java b/src/main/java/org/apache/commons/validator/routines/UrlValidator.java index 9334c3d1..62fb1697 100644 --- a/src/main/java/org/apache/commons/validator/routines/UrlValidator.java +++ b/src/main/java/org/apache/commons/validator/routines/UrlValidator.java @@ -349,7 +349,7 @@ public class UrlValidator implements Serializable { * Note that the method calls #isValidAuthority() * which checks that the domain is valid. * - * @param value The value validation is being performed on. A <code>null</code> + * @param value The value validation is being performed on. A {@code null} * value is considered invalid. * @return true if the URL is valid. */ @@ -400,7 +400,7 @@ public class UrlValidator implements Serializable { /** * Returns true if the authority is properly formatted. An authority is the combination - * of hostname and port. A <code>null</code> authority value is considered invalid. + * of hostname and port. A {@code null} authority value is considered invalid. * Note: this implementation validates the domain unless a RegexValidator was provided. * If a RegexValidator was supplied and it matches, then the authority is regarded * as valid with no further checks, otherwise the method checks against the @@ -479,7 +479,7 @@ public class UrlValidator implements Serializable { } /** - * Returns true if the path is valid. A <code>null</code> value is considered invalid. + * Returns true if the path is valid. A {@code null} value is considered invalid. * @param path Path value to validate. * @return true if path is valid. */ @@ -530,7 +530,7 @@ public class UrlValidator implements Serializable { * then only those schemes are allowed. * Otherwise the default schemes are "http", "https", "ftp". * Matching is case-blind. - * @param scheme The scheme to validate. A <code>null</code> value is considered + * @param scheme The scheme to validate. A {@code null} value is considered * invalid. * @return true if valid. */ 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 cd6c8988..a2a31e5e 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 @@ -413,9 +413,9 @@ * whether validation was successful.</li> * <li><code>validate()</code> methods return a <code>String</code> * value of the matched <i>groups</i> aggregated together or - * <code>null</code> if invalid.</li> + * {@code null} if invalid.</li> * <li><code>match()</code> methods return a <code>String</code> array - * of the matched <i>groups</i> or <code>null</code> if invalid.</li> + * of the matched <i>groups</i> or {@code null} if invalid.</li> * </ul> * </li> * <li><b>Case Sensitivity</b> - matching can be done in either a <i>case diff --git a/src/main/java/org/apache/commons/validator/util/ValidatorUtils.java b/src/main/java/org/apache/commons/validator/util/ValidatorUtils.java index 2557c408..127b739a 100644 --- a/src/main/java/org/apache/commons/validator/util/ValidatorUtils.java +++ b/src/main/java/org/apache/commons/validator/util/ValidatorUtils.java @@ -101,7 +101,7 @@ public class ValidatorUtils { * <code>String</code>. If the property is a <code>String[]</code> or * <code>Collection</code> and it is empty, an empty <code>String</code> * "" is returned. Otherwise, property.toString() is returned. This method - * may return <code>null</code> if there was an error retrieving the + * may return {@code null} if there was an error retrieving the * property. * * @param bean The bean object. diff --git a/src/test/java/org/apache/commons/validator/GenericValidatorImpl.java b/src/test/java/org/apache/commons/validator/GenericValidatorImpl.java index 9b1a7663..701622c0 100644 --- a/src/test/java/org/apache/commons/validator/GenericValidatorImpl.java +++ b/src/test/java/org/apache/commons/validator/GenericValidatorImpl.java @@ -153,7 +153,7 @@ 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} is returned. Otherwise {@code false}. + * @return boolean If the field isn't {@code null} and 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()); diff --git a/src/test/java/org/apache/commons/validator/ValidatorTest.java b/src/test/java/org/apache/commons/validator/ValidatorTest.java index ed72c6a2..56a7097a 100644 --- a/src/test/java/org/apache/commons/validator/ValidatorTest.java +++ b/src/test/java/org/apache/commons/validator/ValidatorTest.java @@ -59,7 +59,7 @@ public class ValidatorTest { } /** - * Formats a <code>String</code> to a <code>Date</code>. The <code>Validator</code> will interpret a <code>null</code> as validation having failed. + * Formats a <code>String</code> to a <code>Date</code>. The <code>Validator</code> will interpret a {@code null} as validation having failed. */ public static Date formatDate(final Object bean, final Field field) { final String value = ValidatorUtils.getValueAsString(bean, field.getProperty()); @@ -232,7 +232,7 @@ public class ValidatorTest { } /** - * Verify that one value generates an error and the other passes. The validation method being tested returns an object (<code>null</code> will be considered + * Verify that one value generates an error and the other passes. The validation method being tested returns an object ({@code null} will be considered * an error). */ @Test