Serialized Form (Apache Commons Validator 1.11.0 API)
Description: serialized forms

# Serialized Form

- ## Package org.apache.commons.validator

  - ### Class org.apache.commons.validator.Arg

    class Arg extends Object implements Serializable
    serialVersionUID:
      -8922606779669839294L

    - #### Serialized Fields

      - ##### bundle

            String bundle

        The resource bundle name that this Arg's `key` should be resolved in (optional).
        Since:
          1.1

      - ##### key

            String key

        The key or value of the argument.

      - ##### name

            String name

        The name dependency that this argument goes with (optional).

      - ##### position

            int position

        This argument's position in the message. Set position=0 to make a replacement in this string: "some msg {0}".
        Since:
          1.1

      - ##### resource

            boolean resource

        Whether or not the key is a message resource (optional). Defaults to true. If it is 'true', the value will try to be resolved as a message resource.

  - ### Class org.apache.commons.validator.Field

    class Field extends Object implements Serializable
    serialVersionUID:
      -8502647722530192185L

    - #### Serialized Fields

      - ##### args

            Map<String,Arg>[] args

        Holds Maps of arguments. args[0] returns the Map for the first replacement argument. Start with a 0 length array so that it will only grow to the size of the highest argument position.
        Since:
          1.1

      - ##### clientValidation

            boolean clientValidation

        The flag that indicates whether scripting should be generated by the client for client-side validation.
        Since:
          1.4

      - ##### dependencyList

            List<String> dependencyList

        Internal representation of this.depends String as a List. This List gets updated whenever setDepends() gets called. This List is synchronized so a call to setDepends() (which clears the List) won't interfere with a call to isDependency().

      - ##### depends

            String depends

        A comma separated list of validator's this field depends on.

      - ##### fieldOrder

            int fieldOrder

        The order of the Field in the Form.

      - ##### hMsgs

            org.apache.commons.collections.FastHashMap hMsgs

        Deprecated.
        Subclasses should use getMsgMap() instead.

      - ##### hVars

            org.apache.commons.collections.FastHashMap hVars

        Deprecated.
        Subclasses should use getVarMap() instead.

      - ##### indexedListProperty

            String indexedListProperty

        The Field's indexed list property name.

      - ##### indexedProperty

            String indexedProperty

        The Field's indexed property name.

      - ##### key

            String key

        The Field's unique key.

      - ##### page

            int page

        The Page Number

      - ##### property

            String property

        The Field's property name.

  - ### Class org.apache.commons.validator.Form

    class Form extends Object implements Serializable
    serialVersionUID:
      6445211789563796371L

    - #### Serialized Fields

      - ##### hFields

            org.apache.commons.collections.FastHashMap hFields

        Deprecated.
        Subclasses should use getFieldMap() instead.
        Map of `Field`s keyed on their property value.

      - ##### inherit

            String inherit

        The name/key of the form which this form extends from.
        Since:
          1.2.0

      - ##### lFields

            List<Field> lFields

        List of `Field`s. Used to maintain the order they were added in although individual `Field`s can be retrieved using `Map` of `Field`s.

      - ##### name

            String name

        The name/key the set of validation rules is stored under.

      - ##### processed

            boolean processed

        Whether or not the this `Form` was processed for replacing variables in strings with their values.

  - ### Class org.apache.commons.validator.FormSet

    class FormSet extends Object implements Serializable
    serialVersionUID:
      -8936513232763306055L

    - #### Serialized Fields

      - ##### constants

            Map<String,String> constants

        A `Map` of `Constant`s using the name field of the `Constant` as the key.

      - ##### country

            String country

        Country component of `Locale` (optional).

      - ##### forms

            Map<String,Form> forms

        A `Map` of `Form`s using the name field of the `Form` as the key.

      - ##### language

            String language

        Language component of `Locale` (required).

      - ##### merged

            boolean merged

        Flag indicating if this formSet has been merged with its parent (higher rank in Locale hierarchy).

      - ##### processed

            boolean processed

        Whether or not the this `FormSet` was processed for replacing variables in strings with their values.

      - ##### variant

            String variant

        Variant component of `Locale` (optional).

  - ### Class org.apache.commons.validator.GenericTypeValidator

    class GenericTypeValidator extends Object implements Serializable
    serialVersionUID:
      5487162314134261703L

  - ### Class org.apache.commons.validator.GenericValidator

    class GenericValidator extends Object implements Serializable
    serialVersionUID:
      -7212095066891517618L

  - ### Class org.apache.commons.validator.Msg

    class Msg extends Object implements Serializable
    serialVersionUID:
      5690015734364127124L

    - #### Serialized Fields

      - ##### bundle

            String bundle

        The resource bundle name that this Msg's `key` should be resolved in (optional).
        Since:
          1.1

      - ##### key

            String key

        The key or value of the argument.

      - ##### name

            String name

        The name dependency that this argument goes with (optional).

      - ##### resource

            boolean resource

        Whether or not the key is a message resource (optional). Defaults to true. If it is 'true', the value will try to be resolved as a message resource.
        Since:
          1.1.4

  - ### Class org.apache.commons.validator.UrlValidator

    class UrlValidator extends Object implements Serializable
    serialVersionUID:
      24137157400029593L

    - #### Serialized Fields

      - ##### allowedSchemes

            Set<String> allowedSchemes

        Deprecated.
        The set of schemes that are allowed to be in a URL.

      - ##### defaultSchemes

            String[] defaultSchemes

        Deprecated.
        If no schemes are provided, default to this set.

      - ##### options

            Flags options

        Deprecated.
        Holds the set of current validation options.

  - ### Class org.apache.commons.validator.Validator

    class Validator extends Object implements Serializable
    serialVersionUID:
      -7119418755208731611L

    - #### Serialized Fields

      - ##### fieldName

            String fieldName

        Deprecated.
        Use `Validator.getFieldName()`, will be private in the next major version.
        The name of the field on the form to validate
        Since:
          1.2.0

      - ##### formName

            String formName

        Deprecated.
        Use `Validator.getFormName()`, will be private in the next major version.
        The name of the form to validate

      - ##### onlyReturnErrors

            boolean onlyReturnErrors

        Deprecated.
        Use `Validator.getOnlyReturnErrors()`, will be private in the next major version.
        Sets this to true to not return Fields that pass validation. Only return failures.

      - ##### page

            int page

        Deprecated.
        Use `Validator.getPage()`, will be private in the next major version.
        The current page number to validate.

      - ##### parameters

            Map<String,Object> parameters

        Deprecated.
        Use `Validator.getParameters()`, will be private in the next major version.
        Maps validation method parameter class names to the objects to be passed into the method.

      - ##### resources

            ValidatorResources resources

        Deprecated.
        Use `Validator.getResources()`, will be private in the next major version.
        The Validator Resources.

      - ##### useContextClassLoader

            boolean useContextClassLoader

        Deprecated.
        Use `Validator.getUseContextClassLoader()`, will be private in the next major version.
        Whether or not to use the Context ClassLoader when loading classes for instantiating new objects. Default is `false`.

  - ### Class org.apache.commons.validator.ValidatorAction

    class ValidatorAction extends Object implements Serializable
    serialVersionUID:
      1339713700053204597L

    - #### Serialized Fields

      - ##### className

            String className

        The full class name of the class containing the validation method associated with this action.

      - ##### dependencyList

            List<String> dependencyList

        An internal List representation of the other `ValidatorAction`s this one depends on (if any). This List gets updated whenever setDepends() gets called. This is synchronized so a call to setDepends() (which clears the List) won't interfere with a call to isDependency().

      - ##### depends

            String depends

        The other `ValidatorAction`s that this one depends on. If any errors occur in an action that this one depends on, this action will not be processed.

      - ##### instance

            Object instance

        If the Java method matching the correct signature isn't static, the instance is stored in the action. This assumes the method is thread safe.

      - ##### javascript

            String javascript

        An optional field to containing a JavaScript representation of the Java method associated with this action.

      - ##### jsFunction

            String jsFunction

        An optional field to contain the class path to be used to retrieve the JavaScript function.

      - ##### jsFunctionName

            String jsFunctionName

        An optional field to contain the name to be used if JavaScript is generated.

      - ##### method

            String method

        The full method name of the validation to be performed. The method must be thread safe.

      - ##### methodParameterList

            List<String> methodParameterList

        An internal List representation of all the validation method's parameters defined in the methodParams String.

      - ##### methodParams

            String methodParams

        The method signature of the validation method. This should be a comma-delimited list of the full class names of each parameter in the correct order that the method takes.

        Note: `Object` is reserved for the JavaBean that is being validated. The `ValidatorAction` and `Field` that are associated with a field's validation will automatically be populated if they are specified in the method signature.

      - ##### msg

            String msg

        The default error message associated with this action.

      - ##### name

            String name

        The name of the validation.

      - ##### parameterClasses

            Class<?>[] parameterClasses

        The Class objects for each entry in methodParameterList.

      - ##### validationClass

            Class<?> validationClass

        The Class object loaded from the class name.

  - ### Exception Class org.apache.commons.validator.ValidatorException

    class ValidatorException extends Exception implements Serializable
    serialVersionUID:
      1025759372615616964L

  - ### Class org.apache.commons.validator.ValidatorResources

    class ValidatorResources extends Object implements Serializable
    serialVersionUID:
      -8203745881446239554L

    - #### Serialized Fields

      - ##### defaultFormSet

            FormSet defaultFormSet

        This is the default `FormSet` (without locale). (We probably don't need the defaultLocale anymore.)

      - ##### hActions

            org.apache.commons.collections.FastHashMap hActions

        Deprecated.
        Subclasses should use getActions() instead.
        `Map` of `ValidatorAction`s with the name of the `ValidatorAction` as the key.

      - ##### hConstants

            org.apache.commons.collections.FastHashMap hConstants

        Deprecated.
        Subclasses should use getConstants() instead.
        `Map` of global constant values with the name of the constant as the key.

      - ##### hFormSets

            org.apache.commons.collections.FastHashMap hFormSets

        Deprecated.
        Subclasses should use getFormSets() instead.
        `Map` of `FormSet`s stored under a `Locale` key (expressed as a String).

  - ### Class org.apache.commons.validator.ValidatorResult

    class ValidatorResult extends Object implements Serializable
    serialVersionUID:
      -3713364681647250531L

    - #### Serialized Fields

      - ##### field

            Field field

        `Field` being validated. TODO This variable is not used. Need to investigate removing it.

      - ##### hAction

            Map<String, ValidatorResult.ResultStatus> hAction

        Map of results. The key is the name of the `ValidatorAction` and the value is whether or not this field passed or not.

  - ### Class org.apache.commons.validator.ValidatorResult.ResultStatus

    class ResultStatus extends Object implements Serializable
    serialVersionUID:
      4076665918535320007L

    - #### Serialized Fields

      - ##### result

            Object result

        Result returned by a validation method.

      - ##### valid

            boolean valid

        Whether or not the validation passed.

  - ### Class org.apache.commons.validator.ValidatorResults

    class ValidatorResults extends Object implements Serializable
    serialVersionUID:
      -2709911078904924839L

    - #### Serialized Fields

      - ##### hResults

            Map<String, ValidatorResult> hResults

        Map of validation results.

  - ### Class org.apache.commons.validator.Var

    class Var extends Object implements Serializable
    serialVersionUID:
      -684185211548420224L

    - #### Serialized Fields

      - ##### bundle

            String bundle

        The bundle for a variable (when resource = 'true').

      - ##### jsType

            String jsType

        The optional JavaScript type of the variable.

      - ##### name

            String name

        The name of the variable.

      - ##### resource

            boolean resource

        Whether the variable is a resource [false]

      - ##### value

            String value

        The key or value the variable.

- ## Package org.apache.commons.validator.routines

  - ### Class org.apache.commons.validator.routines.AbstractCalendarValidator

    class AbstractCalendarValidator extends AbstractFormatValidator implements Serializable
    serialVersionUID:
      -1410008585975827379L

    - #### Serialized Fields

      - ##### dateStyle

            int dateStyle

        The date style to use for Locale validation.

      - ##### timeStyle

            int timeStyle

        The time style to use for Locale validation.

  - ### Class org.apache.commons.validator.routines.AbstractFormatValidator

    class AbstractFormatValidator extends Object implements Serializable
    serialVersionUID:
      -4690687565200568258L

    - #### Serialized Fields

      - ##### strict

            boolean strict

        Whether to use strict format.

  - ### Class org.apache.commons.validator.routines.AbstractNumberValidator

    class AbstractNumberValidator extends AbstractFormatValidator implements Serializable
    serialVersionUID:
      -3088817875906765463L

    - #### Serialized Fields

      - ##### allowFractions

            boolean allowFractions

        `true` if fractions are allowed or `false` if integers only.

      - ##### formatType

            int formatType

        The `NumberFormat` type to create for validation, default is STANDARD_FORMAT.

  - ### Class org.apache.commons.validator.routines.BigDecimalValidator

    class BigDecimalValidator extends AbstractNumberValidator implements Serializable
    serialVersionUID:
      -670320911490506772L

  - ### Class org.apache.commons.validator.routines.BigIntegerValidator

    class BigIntegerValidator extends AbstractNumberValidator implements Serializable
    serialVersionUID:
      6713144356347139988L

  - ### Class org.apache.commons.validator.routines.ByteValidator

    class ByteValidator extends AbstractNumberValidator implements Serializable
    serialVersionUID:
      7001640945881854649L

  - ### Class org.apache.commons.validator.routines.CalendarValidator

    class CalendarValidator extends AbstractCalendarValidator implements Serializable
    serialVersionUID:
      9109652318762134167L

  - ### Class org.apache.commons.validator.routines.CodeValidator

    class CodeValidator extends Object implements Serializable
    serialVersionUID:
      446960910870938233L

    - #### Serialized Fields

      - ##### checkdigit

            CheckDigit checkdigit

        The check digit validation routine.

      - ##### maxLength

            int maxLength

        The maximum length of the code.

      - ##### minLength

            int minLength

        The minimum length of the code.

      - ##### regexValidator

            RegexValidator regexValidator

        The format regular expression validator.

  - ### Class org.apache.commons.validator.routines.CreditCardValidator

    class CreditCardValidator extends Object implements Serializable
    serialVersionUID:
      5955978921148959496L

    - #### Serialized Fields

      - ##### cardTypes

            List<CodeValidator> cardTypes

        The CreditCardTypes that are allowed to pass validation.

  - ### Class org.apache.commons.validator.routines.CurrencyValidator

    class CurrencyValidator extends BigDecimalValidator implements Serializable
    serialVersionUID:
      -4201640771171486514L

  - ### Class org.apache.commons.validator.routines.DateValidator

    class DateValidator extends AbstractCalendarValidator implements Serializable
    serialVersionUID:
      -3966328400469953190L

  - ### Class org.apache.commons.validator.routines.DomainValidator

    class DomainValidator extends Object implements Serializable
    serialVersionUID:
      -4407125112880174009L

    - #### Serialized Fields

      - ##### allowLocal

            boolean allowLocal

        Whether to allow local overrides.

      - ##### domainRegex

            RegexValidator domainRegex

        RegexValidator for matching domains.

      - ##### hostnameRegex

            RegexValidator hostnameRegex

        RegexValidator for matching a local hostname

      - ##### myCountryCodeTLDsMinus

            String[] myCountryCodeTLDsMinus

        Local override.

      - ##### myCountryCodeTLDsPlus

            String[] myCountryCodeTLDsPlus

        Local override.

      - ##### myGenericTLDsMinus

            String[] myGenericTLDsMinus

        Local override.

      - ##### myGenericTLDsPlus

            String[] myGenericTLDsPlus

        Local override.

      - ##### myLocalTLDsMinus

            String[] myLocalTLDsMinus

        Local override.

      - ##### myLocalTLDsPlus

            String[] myLocalTLDsPlus

        Local override.

  - ### Class org.apache.commons.validator.routines.DoubleValidator

    class DoubleValidator extends AbstractNumberValidator implements Serializable
    serialVersionUID:
      5867946581318211330L

  - ### Class org.apache.commons.validator.routines.EmailValidator

    class EmailValidator extends Object implements Serializable
    serialVersionUID:
      1705927040799295880L

    - #### Serialized Fields

      - ##### allowTld

            boolean allowTld

        Whether to allow TLDs.

      - ##### domainValidator

            DomainValidator domainValidator

        The domain validator.

  - ### Class org.apache.commons.validator.routines.FloatValidator

    class FloatValidator extends AbstractNumberValidator implements Serializable
    serialVersionUID:
      -4513245432806414267L

  - ### Class org.apache.commons.validator.routines.InetAddressValidator

    class InetAddressValidator extends Object implements Serializable
    serialVersionUID:
      -919201640201914789L

  - ### Class org.apache.commons.validator.routines.IntegerValidator

    class IntegerValidator extends AbstractNumberValidator implements Serializable
    serialVersionUID:
      422081746310306596L

  - ### Class org.apache.commons.validator.routines.ISBNValidator

    class ISBNValidator extends Object implements Serializable
    serialVersionUID:
      4319515687976420405L

    - #### Serialized Fields

      - ##### convert

            boolean convert

        Whether validation converts an ISBN-10 codes to ISBN-13.

      - ##### isbn10Validator

            CodeValidator isbn10Validator

        ISBN-10 Code Validator

      - ##### isbn13Validator

            CodeValidator isbn13Validator

        ISBN-13 Code Validator

  - ### Class org.apache.commons.validator.routines.ISINValidator

    class ISINValidator extends Object implements Serializable
    serialVersionUID:
      -5964391439144260936L

    - #### Serialized Fields

      - ##### checkCountryCode

            boolean checkCountryCode

        Whether to check the country code during validation.

  - ### Class org.apache.commons.validator.routines.ISSNValidator

    class ISSNValidator extends Object implements Serializable
    serialVersionUID:
      4319515687976420405L

  - ### Class org.apache.commons.validator.routines.LongValidator

    class LongValidator extends AbstractNumberValidator implements Serializable
    serialVersionUID:
      -5117231731027866098L

  - ### Class org.apache.commons.validator.routines.PercentValidator

    class PercentValidator extends BigDecimalValidator implements Serializable
    serialVersionUID:
      -3508241924961535772L

  - ### Class org.apache.commons.validator.routines.RegexValidator

    class RegexValidator extends Object implements Serializable
    serialVersionUID:
      -8832409930574867162L

    - #### Serialized Fields

      - ##### patterns

            Pattern[] patterns

        Compiled RE patterns from constructors.

  - ### Class org.apache.commons.validator.routines.ShortValidator

    class ShortValidator extends AbstractNumberValidator implements Serializable
    serialVersionUID:
      -5227510699747787066L

  - ### Class org.apache.commons.validator.routines.TimeValidator

    class TimeValidator extends AbstractCalendarValidator implements Serializable
    serialVersionUID:
      3494007492269691581L

  - ### Class org.apache.commons.validator.routines.UrlValidator

    class UrlValidator extends Object implements Serializable
    serialVersionUID:
      7557161713937335013L

    - #### Serialized Fields

      - ##### allowedSchemes

            Set<String> allowedSchemes

        The set of schemes that are allowed to be in a URL.

      - ##### authorityValidator

            RegexValidator authorityValidator

        Regular expressions used to manually validate authorities if IANA domain name validation isn't desired.

      - ##### domainValidator

            DomainValidator domainValidator

        The domain validator.

      - ##### options

            long options

        Holds the set of current validation options.

- ## Package org.apache.commons.validator.routines.checkdigit

  - ### Class org.apache.commons.validator.routines.checkdigit.ABANumberCheckDigit

    class ABANumberCheckDigit extends ModulusCheckDigit implements Serializable
    serialVersionUID:
      -8255937433810380145L

  - ### Class org.apache.commons.validator.routines.checkdigit.CASNumberCheckDigit

    class CASNumberCheckDigit extends ModulusCheckDigit implements Serializable
    serialVersionUID:
      -5387334603220786657L

  - ### Exception Class org.apache.commons.validator.routines.checkdigit.CheckDigitException

    class CheckDigitException extends Exception implements Serializable
    serialVersionUID:
      -3519894732624685477L

  - ### Class org.apache.commons.validator.routines.checkdigit.CUSIPCheckDigit

    class CUSIPCheckDigit extends ModulusCheckDigit implements Serializable
    serialVersionUID:
      666941918490152456L

  - ### Class org.apache.commons.validator.routines.checkdigit.EAN13CheckDigit

    class EAN13CheckDigit extends ModulusCheckDigit implements Serializable
    serialVersionUID:
      1726347093230424107L

  - ### Class org.apache.commons.validator.routines.checkdigit.ECNumberCheckDigit

    class ECNumberCheckDigit extends ModulusCheckDigit implements Serializable
    serialVersionUID:
      7265356024784308367L

  - ### Class org.apache.commons.validator.routines.checkdigit.IBANCheckDigit

    class IBANCheckDigit extends org.apache.commons.validator.routines.checkdigit.AbstractCheckDigit implements Serializable
    serialVersionUID:
      -3600191725934382801L

  - ### Class org.apache.commons.validator.routines.checkdigit.ISBN10CheckDigit

    class ISBN10CheckDigit extends ModulusCheckDigit implements Serializable
    serialVersionUID:
      8000855044504864964L

  - ### Class org.apache.commons.validator.routines.checkdigit.ISBNCheckDigit

    class ISBNCheckDigit extends org.apache.commons.validator.routines.checkdigit.AbstractCheckDigit implements Serializable
    serialVersionUID:
      1391849166205184558L

  - ### Class org.apache.commons.validator.routines.checkdigit.ISINCheckDigit

    class ISINCheckDigit extends ModulusCheckDigit implements Serializable
    serialVersionUID:
      -1239211208101323599L

  - ### Class org.apache.commons.validator.routines.checkdigit.ISSNCheckDigit

    class ISSNCheckDigit extends ModulusCheckDigit implements Serializable
    serialVersionUID:
      1L

  - ### Class org.apache.commons.validator.routines.checkdigit.LuhnCheckDigit

    class LuhnCheckDigit extends ModulusCheckDigit implements Serializable
    serialVersionUID:
      -2976900113942875999L

  - ### Class org.apache.commons.validator.routines.checkdigit.ModulusCheckDigit

    class ModulusCheckDigit extends org.apache.commons.validator.routines.checkdigit.AbstractCheckDigit implements Serializable
    serialVersionUID:
      2948962251251528941L

    - #### Serialized Fields

      - ##### modulus

            int modulus

        The modulus can be greater than 10 provided that the implementing class overrides toCheckDigit and toInt (for example as in ISBN10CheckDigit).

  - ### Class org.apache.commons.validator.routines.checkdigit.ModulusTenCheckDigit

    class ModulusTenCheckDigit extends ModulusCheckDigit implements Serializable
    serialVersionUID:
      -3752929983453368497L

    - #### Serialized Fields

      - ##### positionWeight

            int[] positionWeight

        The weighted values to apply based on the character position

      - ##### sumWeightedDigits

            boolean sumWeightedDigits

        `true` if sum the digits of the weighted value

      - ##### useRightPos

            boolean useRightPos

        `true` if use positionWeights from right to left

  - ### Class org.apache.commons.validator.routines.checkdigit.SedolCheckDigit

    class SedolCheckDigit extends ModulusCheckDigit implements Serializable
    serialVersionUID:
      -8976881621148878443L

  - ### Class org.apache.commons.validator.routines.checkdigit.VerhoeffCheckDigit

    class VerhoeffCheckDigit extends org.apache.commons.validator.routines.checkdigit.AbstractCheckDigit implements Serializable
    serialVersionUID:
      4138993995483695178L

- ## Package org.apache.commons.validator.util

  - ### Class org.apache.commons.validator.util.Flags

    class Flags extends Object implements Serializable
    serialVersionUID:
      8481587558770237995L

    - #### Serialized Fields

      - ##### flags

            long flags

        Represents the current flag state.