LongValidator.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * The ASF licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *      http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.apache.commons.validator.routines;

  19. import java.text.Format;
  20. import java.util.Locale;

  22. /**
  23.  * <p><b>Long Validation</b> and Conversion routines (<code>java.lang.Long</code>).</p>
  24.  *
  25.  * <p>This validator provides a number of methods for
  26.  *    validating/converting a <code>String</code> value to
  27.  *    a <code>Long</code> using <code>java.text.NumberFormat</code>
  28.  *    to parse either:</p>
  29.  *    <ul>
  30.  *       <li>using the default format for the default <code>Locale</code></li>
  31.  *       <li>using a specified pattern with the default <code>Locale</code></li>
  32.  *       <li>using the default format for a specified <code>Locale</code></li>
  33.  *       <li>using a specified pattern with a specified <code>Locale</code></li>
  34.  *    </ul>
  35.  *
  36.  * <p>Use one of the <code>isValid()</code> methods to just validate or
  37.  *    one of the <code>validate()</code> methods to validate and receive a
  38.  *    <i>converted</i> <code>Long</code> value.</p>
  39.  *
  40.  * <p>Once a value has been successfully converted the following
  41.  *    methods can be used to perform minimum, maximum and range checks:</p>
  42.  *    <ul>
  43.  *       <li><code>minValue()</code> checks whether the value is greater
  44.  *           than or equal to a specified minimum.</li>
  45.  *       <li><code>maxValue()</code> checks whether the value is less
  46.  *           than or equal to a specified maximum.</li>
  47.  *       <li><code>isInRange()</code> checks whether the value is within
  48.  *           a specified range of values.</li>
  49.  *    </ul>
  50.  *
  51.  * <p>So that the same mechanism used for parsing an <i>input</i> value
  52.  *    for validation can be used to format <i>output</i>, corresponding
  53.  *    <code>format()</code> methods are also provided. That is you can
  54.  *    format either:</p>
  55.  *    <ul>
  56.  *       <li>using a specified pattern</li>
  57.  *       <li>using the format for a specified <code>Locale</code></li>
  58.  *       <li>using the format for the <i>default</i> <code>Locale</code></li>
  59.  *    </ul>
  60.  *
  61.  * @since 1.3.0
  62.  */
  63. public class LongValidator extends AbstractNumberValidator {

  65.     private static final long serialVersionUID = -5117231731027866098L;

  67.     private static final LongValidator VALIDATOR = new LongValidator();

  69.     /**
  70.      * Gets the singleton instance of this validator.
  71.      * @return A singleton instance of the LongValidator.
  72.      */
  73.     public static LongValidator getInstance() {
  74.         return VALIDATOR;
  75.     }

  77.     /**
  78.      * Constructs a <i>strict</i> instance.
  79.      */
  80.     public LongValidator() {
  81.         this(true, STANDARD_FORMAT);
  82.     }

  84.     /**
  85.      * <p>Construct an instance with the specified strict setting
  86.      *    and format type.</p>
  87.      *
  88.      * <p>The <code>formatType</code> specified what type of
  89.      *    <code>NumberFormat</code> is created - valid types
  90.      *    are:</p>
  91.      *    <ul>
  92.      *       <li>AbstractNumberValidator.STANDARD_FORMAT -to create
  93.      *           <i>standard</i> number formats (the default).</li>
  94.      *       <li>AbstractNumberValidator.CURRENCY_FORMAT -to create
  95.      *           <i>currency</i> number formats.</li>
  96.      *       <li>AbstractNumberValidator.PERCENT_FORMAT -to create
  97.      *           <i>percent</i> number formats (the default).</li>
  98.      *    </ul>
  99.      *
  100.      * @param strict {@code true} if strict
  101.      *        <code>Format</code> parsing should be used.
  102.      * @param formatType The <code>NumberFormat</code> type to
  103.      *        create for validation, default is STANDARD_FORMAT.
  104.      */
  105.     public LongValidator(final boolean strict, final int formatType) {
  106.         super(strict, formatType, false);
  107.     }

  109.     /**
  110.      * Check if the value is within a specified range.
  111.      *
  112.      * @param value The <code>Number</code> value to check.
  113.      * @param min The minimum value of the range.
  114.      * @param max The maximum value of the range.
  115.      * @return {@code true} if the value is within the
  116.      *         specified range.
  117.      */
  118.     public boolean isInRange(final long value, final long min, final long max) {
  119.         return value >= min && value <= max;
  120.     }

  122.     /**
  123.      * Check if the value is within a specified range.
  124.      *
  125.      * @param value The <code>Number</code> value to check.
  126.      * @param min The minimum value of the range.
  127.      * @param max The maximum value of the range.
  128.      * @return {@code true} if the value is within the
  129.      *         specified range.
  130.      */
  131.     public boolean isInRange(final Long value, final long min, final long max) {
  132.         return isInRange(value.longValue(), min, max);
  133.     }

  135.     /**
  136.      * Check if the value is less than or equal to a maximum.
  137.      *
  138.      * @param value The value validation is being performed on.
  139.      * @param max The maximum value.
  140.      * @return {@code true} if the value is less than
  141.      *         or equal to the maximum.
  142.      */
  143.     public boolean maxValue(final long value, final long max) {
  144.         return value <= max;
  145.     }

  147.     /**
  148.      * Check if the value is less than or equal to a maximum.
  149.      *
  150.      * @param value The value validation is being performed on.
  151.      * @param max The maximum value.
  152.      * @return {@code true} if the value is less than
  153.      *         or equal to the maximum.
  154.      */
  155.     public boolean maxValue(final Long value, final long max) {
  156.         return maxValue(value.longValue(), max);
  157.     }

  159.     /**
  160.      * Check if the value is greater than or equal to a minimum.
  161.      *
  162.      * @param value The value validation is being performed on.
  163.      * @param min The minimum value.
  164.      * @return {@code true} if the value is greater than
  165.      *         or equal to the minimum.
  166.      */
  167.     public boolean minValue(final long value, final long min) {
  168.         return value >= min;
  169.     }

  171.     /**
  172.      * Check if the value is greater than or equal to a minimum.
  173.      *
  174.      * @param value The value validation is being performed on.
  175.      * @param min The minimum value.
  176.      * @return {@code true} if the value is greater than
  177.      *         or equal to the minimum.
  178.      */
  179.     public boolean minValue(final Long value, final long min) {
  180.         return minValue(value.longValue(), min);
  181.     }

  183.     /**
  184.      * Convert the parsed value to a <code>Long</code>.
  185.      *
  186.      * @param value The parsed <code>Number</code> object created.
  187.      * @param formatter The Format used to parse the value with.
  188.      * @return The parsed <code>Number</code> converted to a
  189.      *         <code>Long</code>.
  190.      */
  191.     @Override
  192.     protected Object processParsedValue(final Object value, final Format formatter) {

  194.         // Parsed value will be Long if it fits in a long and is not fractional
  195.         if (value instanceof Long) {
  196.             return value;
  197.         }
  198.         return null;

  200.     }

  202.     /**
  203.      * <p>Validate/convert a <code>Long</code> using the default
  204.      *    <code>Locale</code>.
  205.      *
  206.      * @param value The value validation is being performed on.
  207.      * @return The parsed <code>Long</code> if valid or {@code null}
  208.      *  if invalid.
  209.      */
  210.     public Long validate(final String value) {
  211.         return (Long) parse(value, (String) null, (Locale) null);
  212.     }

  214.     /**
  215.      * <p>Validate/convert a <code>Long</code> using the
  216.      *    specified <code>Locale</code>.
  217.      *
  218.      * @param value The value validation is being performed on.
  219.      * @param locale The locale to use for the number format, system default if null.
  220.      * @return The parsed <code>Long</code> if valid or {@code null} if invalid.
  221.      */
  222.     public Long validate(final String value, final Locale locale) {
  223.         return (Long) parse(value, (String) null, locale);
  224.     }

  226.     /**
  227.      * <p>Validate/convert a <code>Long</code> using the
  228.      *    specified <i>pattern</i>.
  229.      *
  230.      * @param value The value validation is being performed on.
  231.      * @param pattern The pattern used to validate the value against.
  232.      * @return The parsed <code>Long</code> if valid or {@code null} if invalid.
  233.      */
  234.     public Long validate(final String value, final String pattern) {
  235.         return (Long) parse(value, pattern, (Locale) null);
  236.     }

  238.     /**
  239.      * <p>Validate/convert a <code>Long</code> using the
  240.      *    specified pattern and/ or <code>Locale</code>.
  241.      *
  242.      * @param value The value validation is being performed on.
  243.      * @param pattern The pattern used to validate the value against, or the
  244.      *        default for the <code>Locale</code> if {@code null}.
  245.      * @param locale The locale to use for the date format, system default if null.
  246.      * @return The parsed <code>Long</code> if valid or {@code null} if invalid.
  247.      */
  248.     public Long validate(final String value, final String pattern, final Locale locale) {
  249.         return (Long) parse(value, pattern, locale);
  250.     }
  251. }
Created with JaCoCo 0.8.12.202403310830