001    /*
002     * Copyright 2008 Sun Microsystems, Inc.  All Rights Reserved.
003     * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004     *
005     * This code is free software; you can redistribute it and/or modify it
006     * under the terms of the GNU General Public License version 2 only, as
007     * published by the Free Software Foundation.  Sun designates this
008     * particular file as subject to the "Classpath" exception as provided
009     * by Sun in the LICENSE file that accompanied this code.
010     *
011     * This code is distributed in the hope that it will be useful, but WITHOUT
012     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013     * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014     * version 2 for more details (a copy is included in the LICENSE file that
015     * accompanied this code).
016     *
017     * You should have received a copy of the GNU General Public License version
018     * 2 along with this work; if not, write to the Free Software Foundation,
019     * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020     *
021     * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022     * CA 95054 USA or visit www.sun.com if you need additional information or
023     * have any questions.
024     */
025    
026    package com.sun.tools.javac.api;
027    
028    import java.util.Locale;
029    
030    /**
031     * This interface must be implemented by any javac class that has non-trivial
032     * formatting needs (e.g. where toString() does not apply because of localization).
033     *
034     * @author Maurizio Cimadamore
035     */
036    public interface Formattable {
037    
038        /**
039         * Used to obtain a localized String representing the object accordingly
040         * to a given locale
041         *
042         * @param locale locale in which the object's representation is to be rendered
043         * @param messages messages object used for localization
044         * @return a locale-dependent string representing the object
045         */
046        public String toString(Locale locale, Messages messages);
047        /**
048         * Retrieve a pretty name of this object's kind
049         * @return a string representing the object's kind
050         */
051        String getKind();
052    
053        static class LocalizedString implements Formattable {
054            String key;
055    
056            public LocalizedString(String key) {
057                this.key = key;
058            }
059    
060            public String toString(java.util.Locale l, Messages messages) {
061                return messages.getLocalizedString(l, key);
062            }
063            public String getKind() {
064                return "LocalizedString";
065            }
066    
067            public String toString() {
068                return key;
069            }
070        }
071    }