|
1 /* |
|
2 * Copyright (c) 2008, Oracle and/or its affiliates. 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. Oracle designates this |
|
8 * particular file as subject to the "Classpath" exception as provided |
|
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 * or visit www.oracle.com if you need additional information or have any |
|
23 * questions. |
|
24 */ |
|
25 |
|
26 package com.sun.tools.javac.api; |
|
27 |
|
28 import java.util.Locale; |
|
29 |
|
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 * <p><b>This is NOT part of any supported API. |
|
35 * If you write code that depends on this, you do so at your own risk. |
|
36 * This code and its internal interfaces are subject to change or |
|
37 * deletion without notice.</b> |
|
38 * |
|
39 * @author Maurizio Cimadamore |
|
40 */ |
|
41 public interface Formattable { |
|
42 |
|
43 /** |
|
44 * Used to obtain a localized String representing the object accordingly |
|
45 * to a given locale |
|
46 * |
|
47 * @param locale locale in which the object's representation is to be rendered |
|
48 * @param messages messages object used for localization |
|
49 * @return a locale-dependent string representing the object |
|
50 */ |
|
51 public String toString(Locale locale, Messages messages); |
|
52 /** |
|
53 * Retrieve a pretty name of this object's kind |
|
54 * @return a string representing the object's kind |
|
55 */ |
|
56 String getKind(); |
|
57 |
|
58 static class LocalizedString implements Formattable { |
|
59 String key; |
|
60 |
|
61 public LocalizedString(String key) { |
|
62 this.key = key; |
|
63 } |
|
64 |
|
65 public String toString(java.util.Locale l, Messages messages) { |
|
66 return messages.getLocalizedString(l, key); |
|
67 } |
|
68 public String getKind() { |
|
69 return "LocalizedString"; |
|
70 } |
|
71 |
|
72 public String toString() { |
|
73 return key; |
|
74 } |
|
75 } |
|
76 } |