/*
 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package java.util;

FormattableFlags are passed to the 
Formattable.formatTo() method and modify the output format for Formattables. Implementations of Formattable are responsible for interpreting and validating any flags. 
Since:
 1.5/**
 * FormattableFlags are passed to the {@link Formattable#formatTo
 * Formattable.formatTo()} method and modify the output format for {@linkplain
 * Formattable Formattables}.  Implementations of {@link Formattable} are
 * responsible for interpreting and validating any flags.
 *
 * @since  1.5
 */
public class FormattableFlags {

    // Explicit instantiation of this class is prohibited.
    private FormattableFlags() {}

    
Left-justifies the output.  Spaces ('\u0020') will be added
at the end of the converted value as required to fill the minimum width
of the field.  If this flag is not set then the output will be
right-justified.
 This flag corresponds to '-' ('\u002d') in
the format specifier.
/**
     * Left-justifies the output.  Spaces (<code>'&#92;u0020'</code>) will be added
     * at the end of the converted value as required to fill the minimum width
     * of the field.  If this flag is not set then the output will be
     * right-justified.
     *
     * <p> This flag corresponds to {@code '-'} (<code>'&#92;u002d'</code>) in
     * the format specifier.
     */
    public static final int LEFT_JUSTIFY = 1<<0; // '-'

    
Converts the output to upper case according to the rules of the locale given during creation of the formatter argument of the 
formatTo() method. The output should be equivalent the following invocation of String.toUpperCase(Locale) 
    out.toUpperCase() 
 This flag corresponds to 'S' ('\u0053') in
the format specifier.
/**
     * Converts the output to upper case according to the rules of the
     * {@linkplain java.util.Locale locale} given during creation of the
     * {@code formatter} argument of the {@link Formattable#formatTo
     * formatTo()} method.  The output should be equivalent the following
     * invocation of {@link String#toUpperCase(java.util.Locale)}
     *
     * <pre>
     *     out.toUpperCase() </pre>
     *
     * <p> This flag corresponds to {@code 'S'} (<code>'&#92;u0053'</code>) in
     * the format specifier.
     */
    public static final int UPPERCASE = 1<<1;    // 'S'

    
Requires the output to use an alternate form. The definition of the form is specified by the Formattable. 
 This flag corresponds to '#' ('\u0023') in
the format specifier.
/**
     * Requires the output to use an alternate form.  The definition of the
     * form is specified by the {@code Formattable}.
     *
     * <p> This flag corresponds to {@code '#'} (<code>'&#92;u0023'</code>) in
     * the format specifier.
     */
    public static final int ALTERNATE = 1<<2;    // '#'
}