jdk/src/share/classes/java/time/format/SignStyle.java
author sherman
Wed, 15 May 2013 07:48:57 -0700
changeset 17474 8c100beabcc0
parent 15289 3ac550392e43
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:
15289
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
     1
/*
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
     2
 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
     4
 *
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    10
 *
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    15
 * accompanied this code).
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    16
 *
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    20
 *
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    23
 * questions.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    24
 */
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    25
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    26
/*
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    27
 * This file is available under and governed by the GNU General Public
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    28
 * License version 2 only, as published by the Free Software Foundation.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    29
 * However, the following notice accompanied the original version of this
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    30
 * file:
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    31
 *
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    32
 * Copyright (c) 2008-2012, Stephen Colebourne & Michael Nascimento Santos
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    33
 *
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    34
 * All rights reserved.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    35
 *
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    36
 * Redistribution and use in source and binary forms, with or without
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    37
 * modification, are permitted provided that the following conditions are met:
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    38
 *
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    39
 *  * Redistributions of source code must retain the above copyright notice,
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    40
 *    this list of conditions and the following disclaimer.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    41
 *
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    42
 *  * Redistributions in binary form must reproduce the above copyright notice,
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    43
 *    this list of conditions and the following disclaimer in the documentation
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    44
 *    and/or other materials provided with the distribution.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    45
 *
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    46
 *  * Neither the name of JSR-310 nor the names of its contributors
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    47
 *    may be used to endorse or promote products derived from this software
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    48
 *    without specific prior written permission.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    49
 *
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    50
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    51
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    52
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    53
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    54
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    55
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    56
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    57
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    58
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    59
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    60
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    61
 */
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    62
package java.time.format;
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    63
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    64
/**
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    65
 * Enumeration of ways to handle the positive/negative sign.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    66
 * <p>
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    67
 * The formatting engine allows the positive and negative signs of numbers
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    68
 * to be controlled using this enum.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    69
 * See {@link DateTimeFormatterBuilder} for usage.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    70
 *
17474
8c100beabcc0 8013730: JSR 310 DateTime API Updates III
sherman
parents: 15289
diff changeset
    71
 * @implSpec
15289
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    72
 * This is an immutable and thread-safe enum.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    73
 *
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    74
 * @since 1.8
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    75
 */
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    76
public enum SignStyle {
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    77
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    78
    /**
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    79
     * Style to output the sign only if the value is negative.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    80
     * <p>
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    81
     * In strict parsing, the negative sign will be accepted and the positive sign rejected.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    82
     * In lenient parsing, any sign will be accepted.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    83
     */
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    84
    NORMAL,
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    85
    /**
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    86
     * Style to always output the sign, where zero will output '+'.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    87
     * <p>
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    88
     * In strict parsing, the absence of a sign will be rejected.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    89
     * In lenient parsing, any sign will be accepted, with the absence
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    90
     * of a sign treated as a positive number.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    91
     */
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    92
    ALWAYS,
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    93
    /**
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    94
     * Style to never output sign, only outputting the absolute value.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    95
     * <p>
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    96
     * In strict parsing, any sign will be rejected.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    97
     * In lenient parsing, any sign will be accepted unless the width is fixed.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    98
     */
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
    99
    NEVER,
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   100
    /**
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   101
     * Style to block negative values, throwing an exception on printing.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   102
     * <p>
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   103
     * In strict parsing, any sign will be rejected.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   104
     * In lenient parsing, any sign will be accepted unless the width is fixed.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   105
     */
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   106
    NOT_NEGATIVE,
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   107
    /**
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   108
     * Style to always output the sign if the value exceeds the pad width.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   109
     * A negative value will always output the '-' sign.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   110
     * <p>
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   111
     * In strict parsing, the sign will be rejected unless the pad width is exceeded.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   112
     * In lenient parsing, any sign will be accepted, with the absence
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   113
     * of a sign treated as a positive number.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   114
     */
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   115
    EXCEEDS_PAD;
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   116
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   117
    /**
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   118
     * Parse helper.
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   119
     *
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   120
     * @param positive  true if positive sign parsed, false for negative sign
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   121
     * @param strict  true if strict, false if lenient
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   122
     * @param fixedWidth  true if fixed width, false if not
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   123
     * @return
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   124
     */
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   125
    boolean parse(boolean positive, boolean strict, boolean fixedWidth) {
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   126
        switch (ordinal()) {
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   127
            case 0: // NORMAL
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   128
                // valid if negative or (positive and lenient)
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   129
                return !positive || !strict;
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   130
            case 1: // ALWAYS
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   131
            case 4: // EXCEEDS_PAD
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   132
                return true;
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   133
            default:
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   134
                // valid if lenient and not fixed width
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   135
                return !strict && !fixedWidth;
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   136
        }
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   137
    }
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   138
3ac550392e43 8003680: JSR 310 Date/Time API
sherman
parents:
diff changeset
   139
}