org.apache.poi.ss.usermodel.BuiltinFormats Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of poi Show documentation
Apache POI - Java API To Access Microsoft Format Files
There is a newer version: 5.2.5
/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================== */
package org.apache.poi.ss.usermodel;

/**
 * Utility to identify built-in formats.  The following is a list of the formats as
 * returned by this class.
 *
 *       0, "General"

 *       1, "0"

 *       2, "0.00"

 *       3, "#,##0"

 *       4, "#,##0.00"

 *       5, "$#,##0_);($#,##0)"

 *       6, "$#,##0_);[Red]($#,##0)"

 *       7, "$#,##0.00);($#,##0.00)"

 *       8, "$#,##0.00_);[Red]($#,##0.00)"

 *       9, "0%"

 *       0xa, "0.00%"

 *       0xb, "0.00E+00"

 *       0xc, "# ?/?"

 *       0xd, "# ??/??"

 *       0xe, "m/d/yy"

 *       0xf, "d-mmm-yy"

 *       0x10, "d-mmm"

 *       0x11, "mmm-yy"

 *       0x12, "h:mm AM/PM"

 *       0x13, "h:mm:ss AM/PM"

 *       0x14, "h:mm"

 *       0x15, "h:mm:ss"

 *       0x16, "m/d/yy h:mm"

 *
 *       // 0x17 - 0x24 reserved for international and undocumented
 *       0x25, "#,##0_);(#,##0)"

 *       0x26, "#,##0_);[Red](#,##0)"

 *       0x27, "#,##0.00_);(#,##0.00)"

 *       0x28, "#,##0.00_);[Red](#,##0.00)"

 *       0x29, "_(* #,##0_);_(* (#,##0);_(* \"-\"_);_(@_)"

 *       0x2a, "_($* #,##0_);_($* (#,##0);_($* \"-\"_);_(@_)"

 *       0x2b, "_(* #,##0.00_);_(* (#,##0.00);_(* \"-\"??_);_(@_)"

 *       0x2c, "_($* #,##0.00_);_($* (#,##0.00);_($* \"-\"??_);_(@_)"

 *       0x2d, "mm:ss"

 *       0x2e, "[h]:mm:ss"

 *       0x2f, "mm:ss.0"

 *       0x30, "##0.0E+0"

 *       0x31, "@" - This is text format.

 *       0x31  "text" - Alias for "@"

 */
public final class BuiltinFormats {
    /**
     * The first user-defined number format starts at 164.
     */
    public static final int FIRST_USER_DEFINED_FORMAT_INDEX = 164;

    private static final String[] _formats = {
        "General",
        "0",
        "0.00",
        "#,##0",
        "#,##0.00",
        "\"$\"#,##0_);(\"$\"#,##0)",
        "\"$\"#,##0_);[Red](\"$\"#,##0)",
        "\"$\"#,##0.00_);(\"$\"#,##0.00)",
        "\"$\"#,##0.00_);[Red](\"$\"#,##0.00)",
        "0%",
        "0.00%",
        "0.00E+00",
        "# ?/?",
        "# ??/??",
        "m/d/yy",
        "d-mmm-yy",
        "d-mmm",
        "mmm-yy",
        "h:mm AM/PM",
        "h:mm:ss AM/PM",
        "h:mm",
        "h:mm:ss",
        "m/d/yy h:mm",

        // 0x17 - 0x24 reserved for international and undocumented
        // TODO - one junit relies on these values which seems incorrect
        "reserved-0x17",
        "reserved-0x18",
        "reserved-0x19",
        "reserved-0x1A",
        "reserved-0x1B",
        "reserved-0x1C",
        "reserved-0x1D",
        "reserved-0x1E",
        "reserved-0x1F",
        "reserved-0x20",
        "reserved-0x21",
        "reserved-0x22",
        "reserved-0x23",
        "reserved-0x24",

        "#,##0_);(#,##0)",
        "#,##0_);[Red](#,##0)",
        "#,##0.00_);(#,##0.00)",
        "#,##0.00_);[Red](#,##0.00)",
        "_(* #,##0_);_(* (#,##0);_(* \"-\"_);_(@_)",
        "_(\"$\"* #,##0_);_(\"$\"* (#,##0);_(\"$\"* \"-\"_);_(@_)",
        "_(* #,##0.00_);_(* (#,##0.00);_(* \"-\"??_);_(@_)",
        "_(\"$\"* #,##0.00_);_(\"$\"* (#,##0.00);_(\"$\"* \"-\"??_);_(@_)",
        "mm:ss",
        "[h]:mm:ss",
        "mm:ss.0",
        "##0.0E+0",
        "@"
    };

    /**
     * @return array of built-in data formats
     */
    public static String[] getAll() {
        return _formats.clone();
    }

    /**
     * Get the format string that matches the given format index
     *
     * @param index of a built in format
     * @return string represented at index of format or {@code null} if there is not a built-in format at that index
     */
    public static String getBuiltinFormat(int index) {
        if (index < 0 || index >=_formats.length) {
            return null;
        }
        return _formats[index];
    }

    /**
     * Get the format index that matches the given format string.

     * Automatically converts "text" to excel's format string to represent text.
     *
     * @param pFmt string matching a built-in format
     * @return index of format or -1 if undefined.
     */
    public static int getBuiltinFormat(String pFmt) {
        String fmt = "TEXT".equalsIgnoreCase(pFmt) ? "@" : pFmt;

        int i = -1;
        for (String f : _formats) {
            i++;
            if (f.equals(fmt)) {
                return i;
            }
        }

        return -1;
    }
}