Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javac/api/Formattable.java@8eafba4f61be (annotated)
src/share/classes/com/sun/tools/javac/api/Formattable.java
Thu, 09 Oct 2008 16:07:38 +0100
- author
- mcimadamore
- date
- Thu, 09 Oct 2008 16:07:38 +0100
- changeset 136
- 8eafba4f61be
- parent 80
- 5c9cdeb740f2
- child 161
- ddd75a295501
- permissions
- -rw-r--r--
6406133: JCDiagnostic.getMessage ignores locale argument
Summary: Compiler API should take into account locale settings
Reviewed-by: jjg
| mcimadamore@80 | 1 | /* |
| mcimadamore@80 | 2 | * Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. |
| mcimadamore@80 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| mcimadamore@80 | 4 | * |
| mcimadamore@80 | 5 | * This code is free software; you can redistribute it and/or modify it |
| mcimadamore@80 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| mcimadamore@80 | 7 | * published by the Free Software Foundation. Sun designates this |
| mcimadamore@80 | 8 | * particular file as subject to the "Classpath" exception as provided |
| mcimadamore@80 | 9 | * by Sun in the LICENSE file that accompanied this code. |
| mcimadamore@80 | 10 | * |
| mcimadamore@80 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| mcimadamore@80 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| mcimadamore@80 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| mcimadamore@80 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| mcimadamore@80 | 15 | * accompanied this code). |
| mcimadamore@80 | 16 | * |
| mcimadamore@80 | 17 | * You should have received a copy of the GNU General Public License version |
| mcimadamore@80 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| mcimadamore@80 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| mcimadamore@80 | 20 | * |
| mcimadamore@80 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| mcimadamore@80 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| mcimadamore@80 | 23 | * have any questions. |
| mcimadamore@80 | 24 | */ |
| mcimadamore@80 | 25 | |
| mcimadamore@80 | 26 | package com.sun.tools.javac.api; |
| mcimadamore@80 | 27 | |
| mcimadamore@136 | 28 | import java.util.Locale; |
| mcimadamore@80 | 29 | |
| mcimadamore@80 | 30 | /** |
| mcimadamore@80 | 31 | * This interface must be implemented by any javac class that has non-trivial |
| mcimadamore@80 | 32 | * formatting needs (e.g. where toString() does not apply because of localization). |
| mcimadamore@80 | 33 | * |
| mcimadamore@80 | 34 | * @author Maurizio Cimadamore |
| mcimadamore@80 | 35 | */ |
| mcimadamore@80 | 36 | public interface Formattable { |
| mcimadamore@80 | 37 | |
| mcimadamore@80 | 38 | /** |
| mcimadamore@80 | 39 | * Used to obtain a localized String representing the object accordingly |
| mcimadamore@80 | 40 | * to a given locale |
| mcimadamore@80 | 41 | * |
| mcimadamore@136 | 42 | * @param locale locale in which the object's representation is to be rendered |
| mcimadamore@136 | 43 | * @param messages messages object used for localization |
| mcimadamore@80 | 44 | * @return a locale-dependent string representing the object |
| mcimadamore@80 | 45 | */ |
| mcimadamore@136 | 46 | public String toString(Locale locale, Messages messages); |
| mcimadamore@80 | 47 | /** |
| mcimadamore@80 | 48 | * Retrieve a pretty name of this object's kind |
| mcimadamore@80 | 49 | * @return a string representing the object's kind |
| mcimadamore@80 | 50 | */ |
| mcimadamore@80 | 51 | String getKind(); |
| mcimadamore@80 | 52 | } |
