src/share/classes/com/sun/tools/javac/api/Formattable.java

Fri, 24 Oct 2008 12:46:34 +0100

author
mcimadamore
date
Fri, 24 Oct 2008 12:46:34 +0100
changeset 161
ddd75a295501
parent 136
8eafba4f61be
child 333
7c2d6da61646
permissions
-rw-r--r--

6758789: Some method resolution diagnostic should be improved
Summary: Recent work on diagnostics left out some resolution corner cases
Reviewed-by: jjg

     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  */
    26 package com.sun.tools.javac.api;
    28 import java.util.Locale;
    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 {
    38     /**
    39      * Used to obtain a localized String representing the object accordingly
    40      * to a given locale
    41      *
    42      * @param locale locale in which the object's representation is to be rendered
    43      * @param messages messages object used for localization
    44      * @return a locale-dependent string representing the object
    45      */
    46     public String toString(Locale locale, Messages messages);
    47     /**
    48      * Retrieve a pretty name of this object's kind
    49      * @return a string representing the object's kind
    50      */
    51     String getKind();
    53     static class LocalizedString implements Formattable {
    54         String key;
    56         public LocalizedString(String key) {
    57             this.key = key;
    58         }
    60         public String toString(java.util.Locale l, Messages messages) {
    61             return messages.getLocalizedString(l, key);
    62         }
    63         public String getKind() {
    64             return "LocalizedString";
    65         }
    67         public String toString() {
    68             return key;
    69         }
    70     }
    71 }

mercurial