Home | History | Annotate | Download | only in format
      1 /*
      2  * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
      3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
      4  *
      5  * This code is free software; you can redistribute it and/or modify it
      6  * under the terms of the GNU General Public License version 2 only, as
      7  * published by the Free Software Foundation.  Oracle designates this
      8  * particular file as subject to the "Classpath" exception as provided
      9  * by Oracle in the LICENSE file that accompanied this code.
     10  *
     11  * This code is distributed in the hope that it will be useful, but WITHOUT
     12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
     13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
     14  * version 2 for more details (a copy is included in the LICENSE file that
     15  * accompanied this code).
     16  *
     17  * You should have received a copy of the GNU General Public License version
     18  * 2 along with this work; if not, write to the Free Software Foundation,
     19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
     20  *
     21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
     22  * or visit www.oracle.com if you need additional information or have any
     23  * questions.
     24  */
     25 
     26 /*
     27  * This file is available under and governed by the GNU General Public
     28  * License version 2 only, as published by the Free Software Foundation.
     29  * However, the following notice accompanied the original version of this
     30  * file:
     31  *
     32  * Copyright (c) 2008-2013, Stephen Colebourne & Michael Nascimento Santos
     33  *
     34  * All rights reserved.
     35  *
     36  * Redistribution and use in source and binary forms, with or without
     37  * modification, are permitted provided that the following conditions are met:
     38  *
     39  *  * Redistributions of source code must retain the above copyright notice,
     40  *    this list of conditions and the following disclaimer.
     41  *
     42  *  * Redistributions in binary form must reproduce the above copyright notice,
     43  *    this list of conditions and the following disclaimer in the documentation
     44  *    and/or other materials provided with the distribution.
     45  *
     46  *  * Neither the name of JSR-310 nor the names of its contributors
     47  *    may be used to endorse or promote products derived from this software
     48  *    without specific prior written permission.
     49  *
     50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
     54  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     55  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     56  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     57  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
     58  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
     59  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     60  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     61  */
     62 package java.time.format;
     63 
     64 /**
     65  * Enumeration of different ways to resolve dates and times.
     66  * <p>
     67  * Parsing a text string occurs in two phases.
     68  * Phase 1 is a basic text parse according to the fields added to the builder.
     69  * Phase 2 resolves the parsed field-value pairs into date and/or time objects.
     70  * This style is used to control how phase 2, resolving, happens.
     71  *
     72  * @implSpec
     73  * This is an immutable and thread-safe enum.
     74  *
     75  * @since 1.8
     76  */
     77 public enum ResolverStyle {
     78 
     79     /**
     80      * Style to resolve dates and times strictly.
     81      * <p>
     82      * Using strict resolution will ensure that all parsed values are within
     83      * the outer range of valid values for the field. Individual fields may
     84      * be further processed for strictness.
     85      * <p>
     86      * For example, resolving year-month and day-of-month in the ISO calendar
     87      * system using strict mode will ensure that the day-of-month is valid
     88      * for the year-month, rejecting invalid values.
     89      */
     90     STRICT,
     91     /**
     92      * Style to resolve dates and times in a smart, or intelligent, manner.
     93      * <p>
     94      * Using smart resolution will perform the sensible default for each
     95      * field, which may be the same as strict, the same as lenient, or a third
     96      * behavior. Individual fields will interpret this differently.
     97      * <p>
     98      * For example, resolving year-month and day-of-month in the ISO calendar
     99      * system using smart mode will ensure that the day-of-month is from
    100      * 1 to 31, converting any value beyond the last valid day-of-month to be
    101      * the last valid day-of-month.
    102      */
    103     SMART,
    104     /**
    105      * Style to resolve dates and times leniently.
    106      * <p>
    107      * Using lenient resolution will resolve the values in an appropriate
    108      * lenient manner. Individual fields will interpret this differently.
    109      * <p>
    110      * For example, lenient mode allows the month in the ISO calendar system
    111      * to be outside the range 1 to 12.
    112      * For example, month 15 is treated as being 3 months after month 12.
    113      */
    114     LENIENT;
    115 
    116 }
    117