aoqi@0: /*
aoqi@0:  * Copyright (c) 2008, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.javac.api;
aoqi@0: 
aoqi@0: import java.util.Locale;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * This interface must be implemented by any javac class that has non-trivial
aoqi@0:  * formatting needs (e.g. where toString() does not apply because of localization).
aoqi@0:  *
aoqi@0:  * <p><b>This is NOT part of any supported API.
aoqi@0:  * If you write code that depends on this, you do so at your own risk.
aoqi@0:  * This code and its internal interfaces are subject to change or
aoqi@0:  * deletion without notice.</b>
aoqi@0:  *
aoqi@0:  * @author Maurizio Cimadamore
aoqi@0:  */
aoqi@0: public interface Formattable {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Used to obtain a localized String representing the object accordingly
aoqi@0:      * to a given locale
aoqi@0:      *
aoqi@0:      * @param locale locale in which the object's representation is to be rendered
aoqi@0:      * @param messages messages object used for localization
aoqi@0:      * @return a locale-dependent string representing the object
aoqi@0:      */
aoqi@0:     public String toString(Locale locale, Messages messages);
aoqi@0:     /**
aoqi@0:      * Retrieve a pretty name of this object's kind
aoqi@0:      * @return a string representing the object's kind
aoqi@0:      */
aoqi@0:     String getKind();
aoqi@0: 
aoqi@0:     static class LocalizedString implements Formattable {
aoqi@0:         String key;
aoqi@0: 
aoqi@0:         public LocalizedString(String key) {
aoqi@0:             this.key = key;
aoqi@0:         }
aoqi@0: 
aoqi@0:         public String toString(java.util.Locale l, Messages messages) {
aoqi@0:             return messages.getLocalizedString(l, key);
aoqi@0:         }
aoqi@0:         public String getKind() {
aoqi@0:             return "LocalizedString";
aoqi@0:         }
aoqi@0: 
aoqi@0:         public String toString() {
aoqi@0:             return key;
aoqi@0:         }
aoqi@0:     }
aoqi@0: }