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