/*
 * Redistribution and use of this software and associated documentation ("Software"), with or
 * without modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
 * must also contain a copy of this document.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other materials provided with
 * the distribution.
 *
 * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
 * without prior written permission of Intalio, Inc. For written permission, please contact
 * info@exolab.org.
 *
 * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
 * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
 * Intalio, Inc.
 *
 * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
 *
 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Copyright 2001-2003 (C) Intalio, Inc. All Rights Reserved.
 *
 */
package org.exolab.castor.xml.validators;

import org.exolab.castor.xml.TypeValidator;
import org.exolab.castor.xml.ValidationContext;
import org.exolab.castor.xml.ValidationException;

/**
 * The Short Validation class. This class handles validation for the primitive <code>short</code>
 * and the <code>java.lang.Short</code> types.
 *
 * @author <a href="mailto:visco@intalio.com">Keith Visco</a>
 * @author <a href="mailto:blandin@intalio.com">Arnaud Blandin</a>
 * @version $Revision$ $Date: 2003-03-03 02:57:21 -0700 (Mon, 03 Mar 2003) $
 */
public class ShortValidator extends PatternValidator implements TypeValidator {

  /** If true, we perform "minimum value" validation. */
  private boolean _useMin = false;
  /** If true, we perform "maximum value" validation. */
  private boolean _useMax = false;
  /** If true, we perform "fixed" validation. */
  private boolean _useFixed = false;
  /** Minimum value (inclusive) for this short. (Not used unless _useMin == true.) */
  private short _min = 0;
  /** Maximum value (inclusive) for this short. (Not used unless _useMax == true.) */
  private short _max = 0;
  /** Maximum number of digits in this short. (Not applied if < 0.) */
  private int _totalDigits = -1;
  /** Fixed value of this short. (Not used unless _useFixed == true.) */
  private short _fixed = 0;

  /**
   * Creates a new ShortValidator with no restrictions.
   */
  public ShortValidator() {
    super();
  } // -- ShortValidator

  /**
   * Clears the fixed value for this ShortValidator.
   */
  public void clearFixed() {
    _useFixed = false;
  } // -- clearFixed

  /**
   * Clears the maximum value for this ShortValidator.
   */
  public void clearMax() {
    _useMax = false;
  } // -- clearMax

  /**
   * Clears the minimum value for this ShortValidator.
   */
  public void clearMin() {
    _useMin = false;
  } // -- clearMin

  /**
   * Returns the configured fixed value for short validation. Returns null if no fixed value has
   * been configured.
   *
   * @return the fixed value to validate against.
   */
  public Short getFixed() {
    if (_useFixed) {
      return new Short(_fixed);
    }
    return null;
  } // -- getFixed

  /**
   * Returns the configured maximum value for short validation. Returns null if no maximum has been
   * configured.
   *
   * @return the maximum (inclusive) value to validate against.
   */
  public Short getMaxInclusive() {
    if (_useMax) {
      return new Short(_max);
    }
    return null;
  } // -- getMaxInclusive

  /**
   * Returns the configured minimum value for short validation. Returns null if no minimum has been
   * configured.
   *
   * @return the minimum (inclusive) value to validate against.
   */
  public Short getMinInclusive() {
    if (_useMin) {
      return new Short(_min);
    }
    return null;
  } // -- getMinInclusive

  /**
   * Returns the configured maximum number of digits (inclusive) for short validation. Returns null
   * if no maximum number of digits has been configured.
   *
   * @return the maximum number of digits to validate against.
   */
  public Integer getTotalDigits() {
    if (_totalDigits >= 0) {
      return Integer.valueOf(_totalDigits);
    }
    return null;
  } // -- getTotalDigits

  /**
   * Returns true if a fixed value to validate against has been set.
   *
   * @return true if a fixed value has been set.
   */
  public boolean hasFixed() {
    return _useFixed;
  } // -- hasFixed

  /**
   * Sets the fixed value for short validation.
   * <p>
   * NOTE: If maximum and/or minimum values have been set and the fixed value is not within that
   * max/min range, then no short will pass validation. This is as according to the XML Schema spec.
   *
   * @param fixedValue the fixed value that a short validated with this validator must be equal to.
   */
  public void setFixed(final short fixedValue) {
    _useFixed = true;
    this._fixed = fixedValue;
  } // -- setFixed

  /**
   * Sets the minimum (exclusive) value for short validation. To pass validation, a short must be
   * greater than this value.
   *
   * @param minValue the minimum (exclusive) value for short validation.
   */
  public void setMinExclusive(final short minValue) {
    _useMin = true;
    _min = (short) (minValue + 1);
  } // -- setMinExclusive

  /**
   * Sets the minimum (inclusive) value for short validation. To pass validation, a short must be
   * greater than or equal to this value.
   *
   * @param minValue the minimum (inclusive) value for short validation.
   */
  public void setMinInclusive(final short minValue) {
    _useMin = true;
    _min = minValue;
  } // -- setMinInclusive

  /**
   * Sets the maximum (exclusive) value for short validation. To pass validation, a short must be
   * less than this value.
   *
   * @param maxValue the maximum (exclusive) value for short validation.
   */
  public void setMaxExclusive(final short maxValue) {
    _useMax = true;
    _max = (short) (maxValue - 1);
  } // -- setMaxExclusive

  /**
   * Sets the maximum (inclusive) value for short validation. To pass validation, a short must be
   * less than or equal to this value.
   *
   * @param maxValue the maximum (inclusive) value for short validation.
   */
  public void setMaxInclusive(final short maxValue) {
    _useMax = true;
    _max = maxValue;
  } // -- setMaxInclusive

  /**
   * Sets the maximum number of digits for short validation. To pass validation, a short must have
   * this many digits or fewer. Leading zeros are not counted.
   *
   * @param totalDig the maximum (inclusive) number of digits for short validation. (must be > 0)
   */
  public void setTotalDigits(final int totalDig) {
    if (totalDig <= 0) {
      throw new IllegalArgumentException("ShortValidator: the totalDigits facet must be positive");
    }
    _totalDigits = totalDig;
  }

  /**
   * Validates the given Object.
   *
   * @param s the short to validate
   * @param context the ValidationContext
   * @throws ValidationException if the object fails validation.
   */
  public void validate(final short s, final ValidationContext context) throws ValidationException {
    if (_useFixed && s != _fixed) {
      String err = "short " + s + " is not equal to the fixed value: " + _fixed;
      throw new ValidationException(err);
    }

    if (_useMin && s < _min) {
      String err = "short " + s + " is less than the minimum allowed value: " + _min;
      throw new ValidationException(err);
    }

    if (_useMax && s > _max) {
      String err = "short " + s + " is greater than the maximum allowed value: " + _max;
      throw new ValidationException(err);
    }

    if (_totalDigits != -1) {
      int length = Short.toString(s).length();
      if (s < 0) {
        length--;
      }
      if (length > _totalDigits) {
        String err = "short " + s + " has too many digits -- must have " + _totalDigits
            + " digits or fewer.";
        throw new ValidationException(err);
      }
    }

    if (hasPattern()) {
      super.validate(Short.toString(s), context);
    }
  } // -- validate

  /**
   * Validates the given Object.
   *
   * @param object the Object to validate
   * @throws ValidationException if the object fails validation.
   */
  public void validate(final Object object) throws ValidationException {
    validate(object, (ValidationContext) null);
  } // -- validate

  /**
   * Validates the given Object.
   *
   * @param object the Object to validate
   * @param context the ValidationContext
   * @throws ValidationException if the object fails validation.
   */
  public void validate(final Object object, final ValidationContext context)
      throws ValidationException {
    if (object == null) {
      String err = "ShortValidator cannot validate a null object.";
      throw new ValidationException(err);
    }

    short value = 0;
    try {
      value = ((Short) object).shortValue();
    } catch (Exception ex) {
      String err = "Expecting a Short, received instead: " + object.getClass().getName();
      throw new ValidationException(err);
    }
    validate(value, context);
  } // -- validate

} // -- ShortValidator
