01 /*
02 * Copyright 2004 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package java.util;
27
28 /**
29 * FomattableFlags are passed to the {@link Formattable#formatTo
30 * Formattable.formatTo()} method and modify the output format for {@linkplain
31 * Formattable Formattables}. Implementations of {@link Formattable} are
32 * responsible for interpreting and validating any flags.
33 *
34 * @version 1.8, 05/05/07
35 * @since 1.5
36 */
37 public class FormattableFlags {
38
39 // Explicit instantiation of this class is prohibited.
40 private FormattableFlags() {
41 }
42
43 /**
44 * Left-justifies the output. Spaces (<tt>'\u0020'</tt>) will be added
45 * at the end of the converted value as required to fill the minimum width
46 * of the field. If this flag is not set then the output will be
47 * right-justified.
48 *
49 * <p> This flag corresponds to <tt>'-'</tt> (<tt>'\u002d'</tt>) in
50 * the format specifier.
51 */
52 public static final int LEFT_JUSTIFY = 1 << 0; // '-'
53
54 /**
55 * Converts the output to upper case according to the rules of the
56 * {@linkplain java.util.Locale locale} given during creation of the
57 * <tt>formatter</tt> argument of the {@link Formattable#formatTo
58 * formatTo()} method. The output should be equivalent the following
59 * invocation of {@link String#toUpperCase(java.util.Locale)}
60 *
61 * <pre>
62 * out.toUpperCase() </pre>
63 *
64 * <p> This flag corresponds to <tt>'^'</tt> (<tt>'\u005e'</tt>) in
65 * the format specifier.
66 */
67 public static final int UPPERCASE = 1 << 1; // '^'
68
69 /**
70 * Requires the output to use an alternate form. The definition of the
71 * form is specified by the <tt>Formattable</tt>.
72 *
73 * <p> This flag corresponds to <tt>'#'</tt> (<tt>'\u0023'</tt>) in
74 * the format specifier.
75 */
76 public static final int ALTERNATE = 1 << 2; // '#'
77 }
|