Home » openjdk-7 » java » util » [javadoc | source]

    1   /*
    2    * Copyright (c) 2004, 2010, 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   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    * @since  1.5
   35    */
   36   public class FormattableFlags {
   37   
   38       // Explicit instantiation of this class is prohibited.
   39       private FormattableFlags() {}
   40   
   41       /**
   42        * Left-justifies the output.  Spaces (<tt>'&#92;u0020'</tt>) will be added
   43        * at the end of the converted value as required to fill the minimum width
   44        * of the field.  If this flag is not set then the output will be
   45        * right-justified.
   46        *
   47        * <p> This flag corresponds to <tt>'-'</tt> (<tt>'&#92;u002d'</tt>) in
   48        * the format specifier.
   49        */
   50       public static final int LEFT_JUSTIFY = 1<<0; // '-'
   51   
   52       /**
   53        * Converts the output to upper case according to the rules of the
   54        * {@linkplain java.util.Locale locale} given during creation of the
   55        * <tt>formatter</tt> argument of the {@link Formattable#formatTo
   56        * formatTo()} method.  The output should be equivalent the following
   57        * invocation of {@link String#toUpperCase(java.util.Locale)}
   58        *
   59        * <pre>
   60        *     out.toUpperCase() </pre>
   61        *
   62        * <p> This flag corresponds to <tt>'S'</tt> (<tt>'&#92;u0053'</tt>) in
   63        * the format specifier.
   64        */
   65       public static final int UPPERCASE = 1<<1;    // 'S'
   66   
   67       /**
   68        * Requires the output to use an alternate form.  The definition of the
   69        * form is specified by the <tt>Formattable</tt>.
   70        *
   71        * <p> This flag corresponds to <tt>'#'</tt> (<tt>'&#92;u0023'</tt>) in
   72        * the format specifier.
   73        */
   74       public static final int ALTERNATE = 1<<2;    // '#'
   75   }

Home » openjdk-7 » java » util » [javadoc | source]