You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/12/01 21:37:18 UTC
(commons-validator) 01/02: Javadoc
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
commit fb0b666b8c205a309351f2339b7ab03e8e9957dd
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Dec 1 16:23:31 2023 -0500
Javadoc
---
.../org/apache/commons/validator/ValidatorResult.java | 3 +++
.../validator/routines/AbstractCalendarValidator.java | 6 ++++++
.../validator/routines/AbstractFormatValidator.java | 3 +++
.../validator/routines/AbstractNumberValidator.java | 9 ++++++++-
.../apache/commons/validator/routines/CodeValidator.java | 7 +++++++
.../commons/validator/routines/DomainValidator.java | 16 +++++++++++-----
.../routines/checkdigit/ModulusTenCheckDigit.java | 11 +++++++++++
7 files changed, 49 insertions(+), 6 deletions(-)
diff --git a/src/main/java/org/apache/commons/validator/ValidatorResult.java b/src/main/java/org/apache/commons/validator/ValidatorResult.java
index 0f53fe50..183b6da2 100644
--- a/src/main/java/org/apache/commons/validator/ValidatorResult.java
+++ b/src/main/java/org/apache/commons/validator/ValidatorResult.java
@@ -36,7 +36,10 @@ public class ValidatorResult implements Serializable {
private static final long serialVersionUID = 4076665918535320007L;
+ /** Whether or not the validation passed. */
private boolean valid;
+
+ /** Result returned by a validation method. */
private 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 a3ae34d7..1a623145 100644
--- a/src/main/java/org/apache/commons/validator/routines/AbstractCalendarValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/AbstractCalendarValidator.java
@@ -36,8 +36,14 @@ public abstract class AbstractCalendarValidator extends AbstractFormatValidator
private static final long serialVersionUID = -1410008585975827379L;
+ /**
+ * The date style to use for Locale validation.
+ */
private final int dateStyle;
+ /**
+ * The time style to use for Locale validation.
+ */
private final int timeStyle;
/**
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 86c06e7f..827ea709 100644
--- a/src/main/java/org/apache/commons/validator/routines/AbstractFormatValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/AbstractFormatValidator.java
@@ -33,6 +33,9 @@ public abstract class AbstractFormatValidator implements Serializable {
private static final long serialVersionUID = -4690687565200568258L;
+ /**
+ * Whether to use strict format.
+ */
private final boolean strict;
/**
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 dede0a5a..d3b06b3a 100644
--- a/src/main/java/org/apache/commons/validator/routines/AbstractNumberValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/AbstractNumberValidator.java
@@ -43,8 +43,15 @@ public abstract class AbstractNumberValidator extends AbstractFormatValidator {
/** Percent <code>NumberFormat</code> type */
public static final int PERCENT_FORMAT = 2;
+ /**
+ * {@code true} if fractions are allowed or {@code false} if integers only.
+ */
private final boolean allowFractions;
- private final int formatType;
+
+ /**
+ * The <code>NumberFormat</code> type to create for validation, default is STANDARD_FORMAT.
+ */
+ private final int formatType;
/**
* Constructs an instance with specified <i>strict</i>
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 9834389a..f2d6b7bb 100644
--- a/src/main/java/org/apache/commons/validator/routines/CodeValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/CodeValidator.java
@@ -70,9 +70,16 @@ public final class CodeValidator implements Serializable {
private static final long serialVersionUID = 446960910870938233L;
+ /** The format regular expression validator. */
private final RegexValidator regexValidator;
+
+ /** The minimum length of the code. */
private final int minLength;
+
+ /** The maximum length of the code. */
private final int maxLength;
+
+ /** The check digit validation routine. */
private final CheckDigit checkdigit;
/**
diff --git a/src/main/java/org/apache/commons/validator/routines/DomainValidator.java b/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
index 0edcc7b2..d0c64a0d 100644
--- a/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
+++ b/src/main/java/org/apache/commons/validator/routines/DomainValidator.java
@@ -2021,6 +2021,7 @@ public class DomainValidator implements Serializable {
}
}
+ /** Whether to allow local overrides. */
private final boolean allowLocal;
// ---------------------------------------------
@@ -2051,29 +2052,34 @@ public class DomainValidator implements Serializable {
private final RegexValidator hostnameRegex =
new RegexValidator(DOMAIN_LABEL_REGEX);
- // instance variables allowing local overrides
+ /** Local override. */
final String[] myCountryCodeTLDsMinus;
+ /** Local override. */
final String[] myCountryCodeTLDsPlus;
// Additional arrays to supplement or override the built in ones.
// The PLUS arrays are valid keys, the MINUS arrays are invalid keys
+ /** Local override. */
final String[] myGenericTLDsPlus;
+ /** Local override. */
final String[] myGenericTLDsMinus;
+ /** Local override. */
final String[] myLocalTLDsPlus;
+ /** Local override. */
final String[] myLocalTLDsMinus;
+
/*
- * N.B. It is vital that instances are immutable.
- * This is because the default instances are shared.
- */
+ * It is vital that instances are immutable. This is because the default instances are shared.
+ */
/**
* Private constructor.
- */
+ */
private DomainValidator(final boolean allowLocal) {
this.allowLocal = allowLocal;
// link to class overrides
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 7c061bdf..93164da1 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
@@ -114,8 +114,19 @@ public final class ModulusTenCheckDigit extends ModulusCheckDigit {
private static final long serialVersionUID = -3752929983453368497L;
+ /**
+ * The weighted values to apply based on the character position
+ */
private final int[] postitionWeight;
+
+ /**
+ * {@code true} if use positionWeights from right to left
+ */
private final boolean useRightPos;
+
+ /**
+ * {@code true} if sum the digits of the weighted value
+ */
private final boolean sumWeightedDigits;
/**