    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      https://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.validator.routines;
    018
    019import java.text.DateFormat;
    020import java.text.Format;
    021import java.util.Calendar;
    022import java.util.Locale;
    023import java.util.TimeZone;
    024
    025/**
    026 * <strong>Calendar Validation</strong> and Conversion routines ({@code java.util.Calendar}).
    027 *
    028 * <p>This validator provides a number of methods for validating/converting
    029 *    a {@link String} date value to a {@code java.util.Calendar} using
    030 *    {@link DateFormat} to parse either:</p>
    031 *    <ul>
    032 *       <li>using the default format for the default {@link Locale}</li>
    033 *       <li>using a specified pattern with the default {@link Locale}</li>
    034 *       <li>using the default format for a specified {@link Locale}</li>
    035 *       <li>using a specified pattern with a specified {@link Locale}</li>
    036 *    </ul>
    037 *
    038 * <p>For each of the above mechanisms, conversion method (that is, the
    039 *    {@code validate} methods) implementations are provided which
    040 *    either use the default {@code TimeZone} or allow the
    041 *    {@code TimeZone} to be specified.</p>
    042 *
    043 * <p>Use one of the {@code isValid()} methods to just validate or
    044 *    one of the {@code validate()} methods to validate and receive a
    045 *    <em>converted</em> {@link Calendar} value.</p>
    046 *
    047 * <p>Implementations of the {@code validate()} method are provided
    048 *    to create {@link Calendar} objects for different <em>time zones</em>
    049 *    if the system default is not appropriate.</p>
    050 *
    051 * <p>Alternatively the CalendarValidator's {@code adjustToTimeZone()} method
    052 *    can be used to adjust the {@code TimeZone} of the {@link Calendar}
    053 *    object afterward.</p>
    054 *
    055 * <p>Once a value has been successfully converted the following
    056 *    methods can be used to perform various date comparison checks:</p>
    057 *    <ul>
    058 *       <li>{@code compareDates()} compares the day, month and
    059 *           year of two calendars, returning 0, -1 or +1 indicating
    060 *           whether the first date is equal, before or after the second.</li>
    061 *       <li>{@code compareWeeks()} compares the week and
    062 *           year of two calendars, returning 0, -1 or +1 indicating
    063 *           whether the first week is equal, before or after the second.</li>
    064 *       <li>{@code compareMonths()} compares the month and
    065 *           year of two calendars, returning 0, -1 or +1 indicating
    066 *           whether the first month is equal, before or after the second.</li>
    067 *       <li>{@code compareQuarters()} compares the quarter and
    068 *           year of two calendars, returning 0, -1 or +1 indicating
    069 *           whether the first quarter is equal, before or after the second.</li>
    070 *       <li>{@code compareYears()} compares the
    071 *           year of two calendars, returning 0, -1 or +1 indicating
    072 *           whether the first year is equal, before or after the second.</li>
    073 *    </ul>
    074 *
    075 * <p>So that the same mechanism used for parsing an <em>input</em> value
    076 *    for validation can be used to format <em>output</em>, corresponding
    077 *    {@code format()} methods are also provided. That is you can
    078 *    format either:</p>
    079 *    <ul>
    080 *       <li>using a specified pattern</li>
    081 *       <li>using the format for a specified {@link Locale}</li>
    082 *       <li>using the format for the <em>default</em> {@link Locale}</li>
    083 *    </ul>
    084 *
    085 * @since 1.3.0
    086 */
    087public class CalendarValidator extends AbstractCalendarValidator {
    088
    089    private static final long serialVersionUID = 9109652318762134167L;
    090
    091    private static final CalendarValidator VALIDATOR = new CalendarValidator();
    092
    093    /**
    094     * Adjusts a Calendar's value to a different TimeZone.
    095     *
    096     * @param value The value to adjust.
    097     * @param timeZone The new time zone to use to adjust the Calendar to.
    098     */
    099    public static void adjustToTimeZone(final Calendar value, final TimeZone timeZone) {
    100        if (value.getTimeZone().hasSameRules(timeZone)) {
    101            value.setTimeZone(timeZone);
    102        } else {
    103            final int year = value.get(Calendar.YEAR);
    104            final int month = value.get(Calendar.MONTH);
    105            final int date = value.get(Calendar.DATE);
    106            final int hour = value.get(Calendar.HOUR_OF_DAY);
    107            final int minute = value.get(Calendar.MINUTE);
    108            value.setTimeZone(timeZone);
    109            value.set(year, month, date, hour, minute);
    110        }
    111    }
    112
    113    /**
    114     * Gets the singleton instance of this validator.
    115     *
    116     * @return A singleton instance of the CalendarValidator.
    117     */
    118    public static CalendarValidator getInstance() {
    119        return VALIDATOR;
    120    }
    121
    122    /**
    123     * Constructs a <em>strict</em> instance with <em>short</em>
    124     * date style.
    125     */
    126    public CalendarValidator() {
    127        this(true, DateFormat.SHORT);
    128    }
    129
    130    /**
    131     * Constructs an instance with the specified <em>strict</em>
    132     * and <em>date style</em> parameters.
    133     *
    134     * @param strict {@code true} if strict
    135     *        {@code Format} parsing should be used.
    136     * @param dateStyle The date style to use for Locale validation.
    137     */
    138    public CalendarValidator(final boolean strict, final int dateStyle) {
    139        super(strict, dateStyle, -1);
    140    }
    141
    142    /**
    143     * Compare Dates (day, month and year - not time).
    144     *
    145     * @param value The {@link Calendar} value to check.
    146     * @param compare The {@link Calendar} to compare the value to.
    147     * @return Zero if the dates are equal, -1 if first
    148     * date is less than the seconds and +1 if the first
    149     * date is greater than.
    150     */
    151    public int compareDates(final Calendar value, final Calendar compare) {
    152        return compare(value, compare, Calendar.DATE);
    153    }
    154
    155    /**
    156     * Compare Months (month and year).
    157     *
    158     * @param value The {@link Calendar} value to check.
    159     * @param compare The {@link Calendar} to compare the value to.
    160     * @return Zero if the months are equal, -1 if first
    161     * parameter's month is less than the seconds and +1 if the first
    162     * parameter's month is greater than.
    163     */
    164    public int compareMonths(final Calendar value, final Calendar compare) {
    165        return compare(value, compare, Calendar.MONTH);
    166    }
    167
    168    /**
    169     * Compare Quarters (quarter and year).
    170     *
    171     * @param value The {@link Calendar} value to check.
    172     * @param compare The {@link Calendar} to check the value against.
    173     * @return Zero if the quarters are equal, -1 if first
    174     * parameter's quarter is less than the seconds and +1 if the first
    175     * parameter's quarter is greater than.
    176     */
    177    public int compareQuarters(final Calendar value, final Calendar compare) {
    178        return compareQuarters(value, compare, 1);
    179    }
    180
    181    /**
    182     * Compare Quarters (quarter and year).
    183     *
    184     * @param value The {@link Calendar} value to check.
    185     * @param compare The {@link Calendar} to compare the value to.
    186     * @param monthOfFirstQuarter The  month that the first quarter starts.
    187     * @return Zero if the quarters are equal, -1 if first
    188     * parameter's quarter is less than the seconds and +1 if the first
    189     * parameter's quarter is greater than.
    190     */
    191    @Override
    192    public int compareQuarters(final Calendar value, final Calendar compare, final int monthOfFirstQuarter) {
    193        return super.compareQuarters(value, compare, monthOfFirstQuarter);
    194    }
    195
    196    /**
    197     * Compare Weeks (week and year).
    198     *
    199     * @param value The {@link Calendar} value to check.
    200     * @param compare The {@link Calendar} to compare the value to.
    201     * @return Zero if the weeks are equal, -1 if first
    202     * parameter's week is less than the seconds and +1 if the first
    203     * parameter's week is greater than.
    204     */
    205    public int compareWeeks(final Calendar value, final Calendar compare) {
    206        return compare(value, compare, Calendar.WEEK_OF_YEAR);
    207    }
    208
    209    /**
    210     * Compare Years.
    211     *
    212     * @param value The {@link Calendar} value to check.
    213     * @param compare The {@link Calendar} to compare the value to.
    214     * @return Zero if the years are equal, -1 if first
    215     * parameter's year is less than the seconds and +1 if the first
    216     * parameter's year is greater than.
    217     */
    218    public int compareYears(final Calendar value, final Calendar compare) {
    219        return compare(value, compare, Calendar.YEAR);
    220    }
    221
    222    /**
    223     * Convert the parsed {@code Date} to a {@link Calendar}.
    224     *
    225     * @param value The parsed {@code Date} object created.
    226     * @param formatter The Format used to parse the value with.
    227     * @return The parsed value converted to a {@link Calendar}.
    228     */
    229    @Override
    230    protected Object processParsedValue(final Object value, final Format formatter) {
    231        return ((DateFormat) formatter).getCalendar();
    232    }
    233
    234    /**
    235     * Validate/convert a {@link Calendar} using the default
    236     *    {@link Locale} and {@code TimeZone}.
    237     *
    238     * @param value The value validation is being performed on.
    239     * @return The parsed {@link Calendar} if valid or {@code null}
    240     *  if invalid.
    241     */
    242    public Calendar validate(final String value) {
    243        return (Calendar) parse(value, (String) null, (Locale) null, (TimeZone) null);
    244    }
    245
    246    /**
    247     * Validate/convert a {@link Calendar} using the specified
    248     *    {@link Locale} and default {@code TimeZone}.
    249     *
    250     * @param value The value validation is being performed on.
    251     * @param locale The locale to use for the date format, system default if null.
    252     * @return The parsed {@link Calendar} if valid or {@code null} if invalid.
    253     */
    254    public Calendar validate(final String value, final Locale locale) {
    255        return (Calendar) parse(value, (String) null, locale, (TimeZone) null);
    256    }
    257
    258    /**
    259     * Validate/convert a {@link Calendar} using the specified
    260     *    {@link Locale} and {@code TimeZone}.
    261     *
    262     * @param value The value validation is being performed on.
    263     * @param locale The locale to use for the date format, system default if null.
    264     * @param timeZone The Time Zone used to parse the date, system default if null.
    265     * @return The parsed {@link Calendar} if valid or {@code null} if invalid.
    266     */
    267    public Calendar validate(final String value, final Locale locale, final TimeZone timeZone) {
    268        return (Calendar) parse(value, (String) null, locale, timeZone);
    269    }
    270
    271    /**
    272     * Validate/convert a {@link Calendar} using the specified
    273     *    <em>pattern</em> and default {@code TimeZone}.
    274     *
    275     * @param value The value validation is being performed on.
    276     * @param pattern The pattern used to validate the value against.
    277     * @return The parsed {@link Calendar} if valid or {@code null} if invalid.
    278     */
    279    public Calendar validate(final String value, final String pattern) {
    280        return (Calendar) parse(value, pattern, (Locale) null, (TimeZone) null);
    281    }
    282
    283    /**
    284     * Validate/convert a {@link Calendar} using the specified pattern
    285     *    and {@link Locale} and the default {@code TimeZone}.
    286     *
    287     * @param value The value validation is being performed on.
    288     * @param pattern The pattern used to validate the value against, or the
    289     *        default for the {@link Locale} if {@code null}.
    290     * @param locale The locale to use for the date format, system default if null.
    291     * @return The parsed {@link Calendar} if valid or {@code null} if invalid.
    292     */
    293    public Calendar validate(final String value, final String pattern, final Locale locale) {
    294        return (Calendar) parse(value, pattern, locale, (TimeZone) null);
    295    }
    296
    297    /**
    298     * Validate/convert a {@link Calendar} using the specified
    299     *    pattern, and {@link Locale} and {@code TimeZone}.
    300     *
    301     * @param value The value validation is being performed on.
    302     * @param pattern The pattern used to validate the value against, or the
    303     *        default for the {@link Locale} if {@code null}.
    304     * @param locale The locale to use for the date format, system default if null.
    305     * @param timeZone The Time Zone used to parse the date, system default if null.
    306     * @return The parsed {@link Calendar} if valid or {@code null} if invalid.
    307     */
    308    public Calendar validate(final String value, final String pattern, final Locale locale, final TimeZone timeZone) {
    309        return (Calendar) parse(value, pattern, locale, timeZone);
    310    }
    311
    312    /**
    313     * Validate/convert a {@link Calendar} using the specified
    314     *    <em>pattern</em> and {@code TimeZone}.
    315     *
    316     * @param value The value validation is being performed on.
    317     * @param pattern The pattern used to validate the value against.
    318     * @param timeZone The Time Zone used to parse the date, system default if null.
    319     * @return The parsed {@link Calendar} if valid or {@code null} if invalid.
    320     */
    321    public Calendar validate(final String value, final String pattern, final TimeZone timeZone) {
    322        return (Calendar) parse(value, pattern, (Locale) null, timeZone);
    323    }
    324
    325    /**
    326     * Validate/convert a {@link Calendar} using the specified
    327     *    {@code TimeZone} and default {@link Locale}.
    328     *
    329     * @param value The value validation is being performed on.
    330     * @param timeZone The Time Zone used to parse the date, system default if null.
    331     * @return The parsed {@link Calendar} if valid or {@code null}
    332     *  if invalid.
    333     */
    334    public Calendar validate(final String value, final TimeZone timeZone) {
    335        return (Calendar) parse(value, (String) null, (Locale) null, timeZone);
    336    }
    337
    338}