1 /*

     2  * Copyright 2008 Sun Microsystems, Inc.  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.  Sun designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * 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 com.sun.tools.javac.api;

    27 

    28 import java.util.ResourceBundle;

    29 

    30 /**

    31  * This interface must be implemented by any javac class that has non-trivial

    32  * formatting needs (e.g. where toString() does not apply because of localization).

    33  *

    34  * @author Maurizio Cimadamore

    35  */

    36 public interface Formattable {

    37 

    38     /**

    39      * Used to obtain a localized String representing the object accordingly

    40      * to a given locale

    41      *

    42      * @param bundle resource bundle class used for localization

    43      * @return a locale-dependent string representing the object

    44      */

    45     public String toString(ResourceBundle bundle);

    46     /**

    47      * Retrieve a pretty name of this object's kind

    48      * @return a string representing the object's kind

    49      */

    50     String getKind();

    51 }