151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/* 251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved. 351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is free software; you can redistribute it and/or modify it 651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * under the terms of the GNU General Public License version 2 only, as 751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * published by the Free Software Foundation. Oracle designates this 851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * particular file as subject to the "Classpath" exception as provided 951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by Oracle in the LICENSE file that accompanied this code. 1051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is distributed in the hope that it will be useful, but WITHOUT 1251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * version 2 for more details (a copy is included in the LICENSE file that 1551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * accompanied this code). 1651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * You should have received a copy of the GNU General Public License version 1851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2 along with this work; if not, write to the Free Software Foundation, 1951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or visit www.oracle.com if you need additional information or have any 2351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * questions. 2451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipackage java.util; 2751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/** 2951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * FomattableFlags are passed to the {@link Formattable#formatTo 3051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Formattable.formatTo()} method and modify the output format for {@linkplain 3151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Formattable Formattables}. Implementations of {@link Formattable} are 3251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * responsible for interpreting and validating any flags. 3351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 3451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.5 3551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 3651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipublic class FormattableFlags { 3751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 3851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Explicit instantiation of this class is prohibited. 3951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private FormattableFlags() {} 4051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 4151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 4251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Left-justifies the output. Spaces (<tt>'\u0020'</tt>) will be added 4351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * at the end of the converted value as required to fill the minimum width 4451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of the field. If this flag is not set then the output will be 4551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * right-justified. 4651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 4751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> This flag corresponds to <tt>'-'</tt> (<tt>'\u002d'</tt>) in 4851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the format specifier. 4951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 5051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final int LEFT_JUSTIFY = 1<<0; // '-' 5151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 5251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 5351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Converts the output to upper case according to the rules of the 5451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@linkplain java.util.Locale locale} given during creation of the 5551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>formatter</tt> argument of the {@link Formattable#formatTo 5651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * formatTo()} method. The output should be equivalent the following 5751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * invocation of {@link String#toUpperCase(java.util.Locale)} 5851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 5951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 6051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * out.toUpperCase() </pre> 6151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 6251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> This flag corresponds to <tt>'S'</tt> (<tt>'\u0053'</tt>) in 6351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the format specifier. 6451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 6551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final int UPPERCASE = 1<<1; // 'S' 6651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 6751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 6851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Requires the output to use an alternate form. The definition of the 6951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * form is specified by the <tt>Formattable</tt>. 7051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 7151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> This flag corresponds to <tt>'#'</tt> (<tt>'\u0023'</tt>) in 7251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the format specifier. 7351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 7451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final int ALTERNATE = 1<<2; // '#' 7551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski} 76