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