Skip to content

Commit

Permalink
Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Nov 11, 2023
1 parent ed9339f commit 5ef3bba
Show file tree
Hide file tree
Showing 37 changed files with 54 additions and 54 deletions.
6 changes: 3 additions & 3 deletions src/main/java/org/apache/commons/validator/Validator.java
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ public class Validator implements Serializable {
protected boolean onlyReturnErrors;

/**
* Construct a <code>Validator</code> that will
* Constructs a <code>Validator</code> that will
* use the <code>ValidatorResources</code>
* passed in to retrieve pluggable validators
* the different sets of validation rules.
Expand All @@ -146,7 +146,7 @@ public Validator(final ValidatorResources resources) {
}

/**
* Construct a <code>Validator</code> that will
* Constructs a <code>Validator</code> that will
* use the <code>ValidatorResources</code>
* passed in to retrieve pluggable validators
* the different sets of validation rules.
Expand All @@ -164,7 +164,7 @@ public Validator(final ValidatorResources resources, final String formName) {
}

/**
* Construct a <code>Validator</code> that will
* Constructs a <code>Validator</code> that will
* use the <code>ValidatorResources</code>
* passed in to retrieve pluggable validators
* the different sets of validation rules.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ protected static class ResultStatus implements Serializable {
private Object result;

/**
* Construct a Result status.
* Constructs a Result status.
* @param valid Whether the validator passed or failed.
* @param result Value returned by the validator.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public abstract class AbstractCalendarValidator extends AbstractFormatValidator
private final int timeStyle;

/**
* Construct an instance with the specified <i>strict</i>,
* Constructs an instance with the specified <i>strict</i>,
* <i>time</i> and <i>date</i> style parameters.
*
* @param strict {@code true} if strict
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public abstract class AbstractFormatValidator implements Serializable {
private final boolean strict;

/**
* Construct an instance with the specified strict setting.
* Constructs an instance with the specified strict setting.
*
* @param strict {@code true} if strict
* <code>Format</code> parsing should be used.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public abstract class AbstractNumberValidator extends AbstractFormatValidator {
private final int formatType;

/**
* Construct an instance with specified <i>strict</i>
* Constructs an instance with specified <i>strict</i>
* and <i>decimal</i> parameters.
*
* @param strict {@code true} if strict
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ public static BigDecimalValidator getInstance() {
}

/**
* Construct a <i>strict</i> instance.
* Constructs a <i>strict</i> instance.
*/
public BigDecimalValidator() {
this(true);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ public static BigIntegerValidator getInstance() {
}

/**
* Construct a <i>strict</i> instance.
* Constructs a <i>strict</i> instance.
*/
public BigIntegerValidator() {
this(true, STANDARD_FORMAT);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public static ByteValidator getInstance() {
}

/**
* Construct a <i>strict</i> instance.
* Constructs a <i>strict</i> instance.
*/
public ByteValidator() {
this(true, STANDARD_FORMAT);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,15 +99,15 @@ public static CalendarValidator getInstance() {
}

/**
* Construct a <i>strict</i> instance with <i>short</i>
* Constructs a <i>strict</i> instance with <i>short</i>
* date style.
*/
public CalendarValidator() {
this(true, DateFormat.SHORT);
}

/**
* Construct an instance with the specified <i>strict</i>
* Constructs an instance with the specified <i>strict</i>
* and <i>date style</i> parameters.
*
* @param strict {@code true} if strict
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public final class CodeValidator implements Serializable {
private final CheckDigit checkdigit;

/**
* Construct a code validator with a specified regular
* Constructs a code validator with a specified regular
* expression and {@link CheckDigit}.
* The RegexValidator validator is created to be case-sensitive
*
Expand All @@ -88,7 +88,7 @@ public CodeValidator(final String regex, final CheckDigit checkdigit) {
}

/**
* Construct a code validator with a specified regular
* Constructs a code validator with a specified regular
* expression, length and {@link CheckDigit}.
* The RegexValidator validator is created to be case-sensitive
*
Expand All @@ -102,7 +102,7 @@ public CodeValidator(final String regex, final int length, final CheckDigit chec
}

/**
* Construct a code validator with a specified regular
* Constructs a code validator with a specified regular
* expression, minimum/maximum length and {@link CheckDigit} validation.
* The RegexValidator validator is created to be case-sensitive
*
Expand All @@ -124,7 +124,7 @@ public CodeValidator(final String regex, final int minLength, final int maxLengt
}

/**
* Construct a code validator with a specified regular expression,
* Constructs a code validator with a specified regular expression,
* validator and {@link CheckDigit} validation.
*
* @param regexValidator The format regular expression validator
Expand All @@ -135,7 +135,7 @@ public CodeValidator(final RegexValidator regexValidator, final CheckDigit check
}

/**
* Construct a code validator with a specified regular expression,
* Constructs a code validator with a specified regular expression,
* validator, length and {@link CheckDigit} validation.
*
* @param regexValidator The format regular expression validator
Expand All @@ -148,7 +148,7 @@ public CodeValidator(final RegexValidator regexValidator, final int length, fina
}

/**
* Construct a code validator with a specified regular expression
* Constructs a code validator with a specified regular expression
* validator, minimum/maximum length and {@link CheckDigit} validation.
*
* @param regexValidator The format regular expression validator
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,14 @@ public static BigDecimalValidator getInstance() {
}

/**
* Construct a <i>strict</i> instance.
* Constructs a <i>strict</i> instance.
*/
public CurrencyValidator() {
this(true, true);
}

/**
* Construct an instance with the specified strict setting.
* Constructs an instance with the specified strict setting.
*
* @param strict {@code true} if strict
* <code>Format</code> parsing should be used.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,15 +96,15 @@ public static DateValidator getInstance() {
}

/**
* Construct a <i>strict</i> instance with <i>short</i>
* Constructs a <i>strict</i> instance with <i>short</i>
* date style.
*/
public DateValidator() {
this(true, DateFormat.SHORT);
}

/**
* Construct an instance with the specified <i>strict</i>
* Constructs an instance with the specified <i>strict</i>
* and <i>date style</i> parameters.
*
* @param strict {@code true} if strict
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public static DoubleValidator getInstance() {
}

/**
* Construct a <i>strict</i> instance.
* Constructs a <i>strict</i> instance.
*/
public DoubleValidator() {
this(true, STANDARD_FORMAT);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public static FloatValidator getInstance() {
}

/**
* Construct a <i>strict</i> instance.
* Constructs a <i>strict</i> instance.
*/
public FloatValidator() {
this(true, STANDARD_FORMAT);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,15 +130,15 @@ public static ISBNValidator getInstance(final boolean convert) {
}

/**
* Construct an ISBN validator which converts ISBN-10 codes
* Constructs an ISBN validator which converts ISBN-10 codes
* to ISBN-13.
*/
public ISBNValidator() {
this(true);
}

/**
* Construct an ISBN validator indicating whether
* Constructs an ISBN validator indicating whether
* ISBN-10 codes should be converted to ISBN-13.
*
* @param convert {@code true} if valid ISBN-10 codes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public static IntegerValidator getInstance() {
}

/**
* Construct a <i>strict</i> instance.
* Constructs a <i>strict</i> instance.
*/
public IntegerValidator() {
this(true, STANDARD_FORMAT);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public static LongValidator getInstance() {
}

/**
* Construct a <i>strict</i> instance.
* Constructs a <i>strict</i> instance.
*/
public LongValidator() {
this(true, STANDARD_FORMAT);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,14 @@ public static BigDecimalValidator getInstance() {
}

/**
* Construct a <i>strict</i> instance.
* Constructs a <i>strict</i> instance.
*/
public PercentValidator() {
this(true);
}

/**
* Construct an instance with the specified strict setting.
* Constructs an instance with the specified strict setting.
*
* @param strict {@code true} if strict
* <code>Format</code> parsing should be used.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
/**
* <b>Regular Expression</b> validation (using the JRE's regular expression support).
* <p>
* Construct the validator either for a single regular expression or a set (array) of
* Constructs the validator either for a single regular expression or a set (array) of
* regular expressions. By default validation is <i>case sensitive</i> but constructors
* are provided to allow <i>case in-sensitive</i> validation. For example to create
* a validator which does <i>case in-sensitive</i> validation for a set of regular
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public static ShortValidator getInstance() {
}

/**
* Construct a <i>strict</i> instance.
* Constructs a <i>strict</i> instance.
*/
public ShortValidator() {
this(true, STANDARD_FORMAT);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,15 +96,15 @@ public static TimeValidator getInstance() {
}

/**
* Construct a <i>strict</i> instance with <i>short</i>
* Constructs a <i>strict</i> instance with <i>short</i>
* time style.
*/
public TimeValidator() {
this(true, DateFormat.SHORT);
}

/**
* Construct an instance with the specified <i>strict</i>
* Constructs an instance with the specified <i>strict</i>
* and <i>time style</i> parameters.
*
* @param strict {@code true} if strict
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public final class ABANumberCheckDigit extends ModulusCheckDigit {
private static final int[] POSITION_WEIGHT = {3, 1, 7};

/**
* Construct a modulus 10 Check Digit routine for ABA Numbers.
* Constructs a modulus 10 Check Digit routine for ABA Numbers.
*/
public ABANumberCheckDigit() {
super(10); // CHECKSTYLE IGNORE MagicNumber
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public final class CUSIPCheckDigit extends ModulusCheckDigit {
private static final int[] POSITION_WEIGHT = {2, 1};

/**
* Construct a CUSIP Identifier Check Digit routine.
* Constructs a CUSIP Identifier Check Digit routine.
*/
public CUSIPCheckDigit() {
super(10); // CHECKSTYLE IGNORE MagicNumber
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ public class CheckDigitException extends Exception {
private static final long serialVersionUID = -3519894732624685477L;

/**
* Construct an Exception with no message.
* Constructs an Exception with no message.
*/
public CheckDigitException() {
}

/**
* Construct an Exception with a message.
* Constructs an Exception with a message.
*
* @param msg The error message.
*/
Expand All @@ -41,7 +41,7 @@ public CheckDigitException(final String msg) {
}

/**
* Construct an Exception with a message and
* Constructs an Exception with a message and
* the underlying cause.
*
* @param msg The error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public final class EAN13CheckDigit extends ModulusCheckDigit {
private static final int[] POSITION_WEIGHT = {3, 1};

/**
* Construct a modulus 10 Check Digit routine for EAN/UPC.
* Constructs a modulus 10 Check Digit routine for EAN/UPC.
*/
public EAN13CheckDigit() {
super(10); // CHECKSTYLE IGNORE MagicNumber
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public final class IBANCheckDigit implements CheckDigit, Serializable {
private static final long MODULUS = 97;

/**
* Construct Check Digit routine for IBAN Numbers.
* Constructs Check Digit routine for IBAN Numbers.
*/
public IBANCheckDigit() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public final class ISBN10CheckDigit extends ModulusCheckDigit {
public static final CheckDigit ISBN10_CHECK_DIGIT = new ISBN10CheckDigit();

/**
* Construct a modulus 11 Check Digit routine for ISBN-10.
* Constructs a modulus 11 Check Digit routine for ISBN-10.
*/
public ISBN10CheckDigit() {
super(11); // CHECKSTYLE IGNORE MagicNumber
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public final class ISINCheckDigit extends ModulusCheckDigit {
private static final int[] POSITION_WEIGHT = {2, 1};

/**
* Construct an ISIN Identifier Check Digit routine.
* Constructs an ISIN Identifier Check Digit routine.
*/
public ISINCheckDigit() {
super(10); // CHECKSTYLE IGNORE MagicNumber
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public final class LuhnCheckDigit extends ModulusCheckDigit {
private static final int[] POSITION_WEIGHT = {2, 1};

/**
* Construct a modulus 10 Luhn Check Digit routine.
* Constructs a modulus 10 Luhn Check Digit routine.
*/
public LuhnCheckDigit() {
super(10); // CHECKSTYLE IGNORE MagicNumber
Expand Down
Loading

0 comments on commit 5ef3bba

Please sign in to comment.