Class LongValidator

java.lang.Object
org.exolab.castor.xml.validators.PatternValidator
org.exolab.castor.xml.validators.LongValidator
All Implemented Interfaces:
TypeValidator

public class LongValidator extends PatternValidator implements TypeValidator
The Long Validation class. This class handles validation for the primitive long and java.lang.Long types as well as all integer derived types such as positive-integer and negative-integer
Version:
$Revision: 6587 $ $Date: 2003-03-03 02:57:21 -0700 (Mon, 03 Mar 2003) $
Author:
Keith Visco
  • Constructor Details

    • LongValidator

      public LongValidator()
      Creates a new LongValidator with no restrictions.
  • Method Details

    • clearFixed

      public void clearFixed()
      Clears the fixed value for this LongValidator.
    • clearMax

      public void clearMax()
      Clears the maximum value for this LongValidator.
    • clearMin

      public void clearMin()
      Clears the minimum value for this LongValidator.
    • getFixed

      public Long getFixed()
      Returns the configured fixed value for long validation. Returns null if no fixed value has been configured.
      Returns:
      the fixed value to validate against.
    • getMaxInclusive

      public Long getMaxInclusive()
      Returns the configured maximum value for long validation. Returns null if no maximum has been configured.
      Returns:
      the maximum (inclusive) value to validate against.
    • getMinInclusive

      public Long getMinInclusive()
      Returns the configured minimum value for long validation. Returns null if no minimum has been configured.
      Returns:
      the minimum (inclusive) value to validate against.
    • getTotalDigits

      public Integer getTotalDigits()
      Returns the configured maximum number of digits (inclusive) for long validation. Returns null if no maximum number of digits has been configured.
      Returns:
      the maximum number of digits to validate against.
    • hasFixed

      public boolean hasFixed()
      Returns true if a fixed value to validate against has been set.
      Returns:
      true if a fixed value has been set.
    • setFixed

      public void setFixed(long fixedValue)
      Sets the fixed value for long validation.

      NOTE: If maximum and/or minimum values have been set and the fixed value is not within that max/min range, then no long will pass validation. This is as according to the XML Schema spec.

      Parameters:
      fixedValue - the fixed value that a long validated with this validator must be equal to.
    • setMinExclusive

      public void setMinExclusive(long minValue)
      Sets the minimum (exclusive) value for long validation. To pass validation, a long must be greater than this value.
      Parameters:
      minValue - the minimum (exclusive) value for long validation.
    • setMinInclusive

      public void setMinInclusive(long minValue)
      Sets the minimum (inclusive) value for long validation. To pass validation, a long must be greater than or equal to this value.
      Parameters:
      minValue - the minimum (inclusive) value for long validation.
    • setMaxExclusive

      public void setMaxExclusive(long maxValue)
      Sets the maximum (exclusive) value for long validation. To pass validation, a long must be less than this value.
      Parameters:
      maxValue - the maximum (exclusive) value for long validation.
    • setMaxInclusive

      public void setMaxInclusive(long maxValue)
      Sets the maximum (inclusive) value for long validation. To pass validation, a long must be less than or equal to this value.
      Parameters:
      maxValue - the maximum (inclusive) value for long validation.
    • setTotalDigits

      public void setTotalDigits(int totalDig)
      Sets the maximum number of digits for long validation. To pass validation, a long must have this many digits or fewer. Leading zeros are not counted.
      Parameters:
      totalDig - the maximum (inclusive) number of digits for long validation. (must be > 0)
    • validate

      public void validate(long value, ValidationContext context) throws ValidationException
      Validates the given Object.
      Parameters:
      value - the long to validate
      context - the ValidationContext
      Throws:
      ValidationException - if the object fails validation.
    • validate

      public void validate(Object object) throws ValidationException
      Validates the given Object.
      Parameters:
      object - the Object to validate
      Throws:
      ValidationException - if the object fails validation.
    • validate

      public void validate(Object object, ValidationContext context) throws ValidationException
      Validates the given Object.
      Specified by:
      validate in interface TypeValidator
      Overrides:
      validate in class PatternValidator
      Parameters:
      object - the Object to validate
      context - the ValidationContext
      Throws:
      ValidationException - if the object fails validation.