Home | History | Annotate | Download | only in format
      1 /*
      2  * Copyright (c) 2012, 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-2012, 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 ways to handle the positive/negative sign.
     66  * <p>
     67  * The formatting engine allows the positive and negative signs of numbers
     68  * to be controlled using this enum.
     69  * See {@link DateTimeFormatterBuilder} for usage.
     70  *
     71  * @implSpec
     72  * This is an immutable and thread-safe enum.
     73  *
     74  * @since 1.8
     75  */
     76 public enum SignStyle {
     77 
     78     /**
     79      * Style to output the sign only if the value is negative.
     80      * <p>
     81      * In strict parsing, the negative sign will be accepted and the positive sign rejected.
     82      * In lenient parsing, any sign will be accepted.
     83      */
     84     NORMAL,
     85     /**
     86      * Style to always output the sign, where zero will output '+'.
     87      * <p>
     88      * In strict parsing, the absence of a sign will be rejected.
     89      * In lenient parsing, any sign will be accepted, with the absence
     90      * of a sign treated as a positive number.
     91      */
     92     ALWAYS,
     93     /**
     94      * Style to never output sign, only outputting the absolute value.
     95      * <p>
     96      * In strict parsing, any sign will be rejected.
     97      * In lenient parsing, any sign will be accepted unless the width is fixed.
     98      */
     99     NEVER,
    100     /**
    101      * Style to block negative values, throwing an exception on printing.
    102      * <p>
    103      * In strict parsing, any sign will be rejected.
    104      * In lenient parsing, any sign will be accepted unless the width is fixed.
    105      */
    106     NOT_NEGATIVE,
    107     /**
    108      * Style to always output the sign if the value exceeds the pad width.
    109      * A negative value will always output the '-' sign.
    110      * <p>
    111      * In strict parsing, the sign will be rejected unless the pad width is exceeded.
    112      * In lenient parsing, any sign will be accepted, with the absence
    113      * of a sign treated as a positive number.
    114      */
    115     EXCEEDS_PAD;
    116 
    117     /**
    118      * Parse helper.
    119      *
    120      * @param positive  true if positive sign parsed, false for negative sign
    121      * @param strict  true if strict, false if lenient
    122      * @param fixedWidth  true if fixed width, false if not
    123      * @return
    124      */
    125     boolean parse(boolean positive, boolean strict, boolean fixedWidth) {
    126         switch (ordinal()) {
    127             case 0: // NORMAL
    128                 // valid if negative or (positive and lenient)
    129                 return !positive || !strict;
    130             case 1: // ALWAYS
    131             case 4: // EXCEEDS_PAD
    132                 return true;
    133             default:
    134                 // valid if lenient and not fixed width
    135                 return !strict && !fixedWidth;
    136         }
    137     }
    138 
    139 }
    140