Thu, 31 Aug 2017 15:17:03 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | package com.sun.tools.doclets.internal.toolkit.util; |
aoqi@0 | 26 | |
aoqi@0 | 27 | import java.text.MessageFormat; |
aoqi@0 | 28 | import java.util.*; |
aoqi@0 | 29 | |
aoqi@0 | 30 | import com.sun.javadoc.*; |
aoqi@0 | 31 | import com.sun.tools.doclets.internal.toolkit.Configuration; |
aoqi@0 | 32 | |
aoqi@0 | 33 | |
aoqi@0 | 34 | /** |
aoqi@0 | 35 | * Retrieve and format messages stored in a resource. |
aoqi@0 | 36 | * |
aoqi@0 | 37 | * <p><b>This is NOT part of any supported API. |
aoqi@0 | 38 | * If you write code that depends on this, you do so at your own risk. |
aoqi@0 | 39 | * This code and its internal interfaces are subject to change or |
aoqi@0 | 40 | * deletion without notice.</b> |
aoqi@0 | 41 | * |
aoqi@0 | 42 | * @since 1.2 |
aoqi@0 | 43 | * @author Atul M Dambalkar |
aoqi@0 | 44 | * @author Robert Field |
aoqi@0 | 45 | */ |
aoqi@0 | 46 | public class MessageRetriever { |
aoqi@0 | 47 | /** |
aoqi@0 | 48 | * The global configuration information for this run. |
aoqi@0 | 49 | */ |
aoqi@0 | 50 | private final Configuration configuration; |
aoqi@0 | 51 | |
aoqi@0 | 52 | /** |
aoqi@0 | 53 | * The location from which to lazily fetch the resource.. |
aoqi@0 | 54 | */ |
aoqi@0 | 55 | private final String resourcelocation; |
aoqi@0 | 56 | |
aoqi@0 | 57 | /** |
aoqi@0 | 58 | * The lazily fetched resource.. |
aoqi@0 | 59 | */ |
aoqi@0 | 60 | private ResourceBundle messageRB; |
aoqi@0 | 61 | |
aoqi@0 | 62 | /** |
aoqi@0 | 63 | * Initialize the ResourceBundle with the given resource. |
aoqi@0 | 64 | * |
aoqi@0 | 65 | * @param rb the resource bundle to read. |
aoqi@0 | 66 | */ |
aoqi@0 | 67 | public MessageRetriever(ResourceBundle rb) { |
aoqi@0 | 68 | this.configuration = null; |
aoqi@0 | 69 | this.messageRB = rb; |
aoqi@0 | 70 | this.resourcelocation = null; |
aoqi@0 | 71 | } |
aoqi@0 | 72 | |
aoqi@0 | 73 | /** |
aoqi@0 | 74 | * Initialize the ResourceBundle with the given resource. |
aoqi@0 | 75 | * |
aoqi@0 | 76 | * @param configuration the configuration |
aoqi@0 | 77 | * @param resourcelocation Resource. |
aoqi@0 | 78 | */ |
aoqi@0 | 79 | public MessageRetriever(Configuration configuration, |
aoqi@0 | 80 | String resourcelocation) { |
aoqi@0 | 81 | this.configuration = configuration; |
aoqi@0 | 82 | this.resourcelocation = resourcelocation; |
aoqi@0 | 83 | } |
aoqi@0 | 84 | |
aoqi@0 | 85 | /** |
aoqi@0 | 86 | * Get and format message string from resource |
aoqi@0 | 87 | * |
aoqi@0 | 88 | * @param key selects message from resource |
aoqi@0 | 89 | * @param args arguments to be replaced in the message. |
aoqi@0 | 90 | * @throws MissingResourceException when the key does not |
aoqi@0 | 91 | * exist in the properties file. |
aoqi@0 | 92 | */ |
aoqi@0 | 93 | public String getText(String key, Object... args) throws MissingResourceException { |
aoqi@0 | 94 | if (messageRB == null) { |
aoqi@0 | 95 | try { |
aoqi@0 | 96 | messageRB = ResourceBundle.getBundle(resourcelocation); |
aoqi@0 | 97 | } catch (MissingResourceException e) { |
aoqi@0 | 98 | throw new Error("Fatal: Resource (" + resourcelocation + |
aoqi@0 | 99 | ") for javadoc doclets is missing."); |
aoqi@0 | 100 | } |
aoqi@0 | 101 | } |
aoqi@0 | 102 | String message = messageRB.getString(key); |
aoqi@0 | 103 | return MessageFormat.format(message, args); |
aoqi@0 | 104 | } |
aoqi@0 | 105 | |
aoqi@0 | 106 | /** |
aoqi@0 | 107 | * Print error message, increment error count. |
aoqi@0 | 108 | * |
aoqi@0 | 109 | * @param pos the position of the source |
aoqi@0 | 110 | * @param msg message to print |
aoqi@0 | 111 | */ |
aoqi@0 | 112 | private void printError(SourcePosition pos, String msg) { |
aoqi@0 | 113 | configuration.root.printError(pos, msg); |
aoqi@0 | 114 | } |
aoqi@0 | 115 | |
aoqi@0 | 116 | /** |
aoqi@0 | 117 | * Print error message, increment error count. |
aoqi@0 | 118 | * |
aoqi@0 | 119 | * @param msg message to print |
aoqi@0 | 120 | */ |
aoqi@0 | 121 | private void printError(String msg) { |
aoqi@0 | 122 | configuration.root.printError(msg); |
aoqi@0 | 123 | } |
aoqi@0 | 124 | |
aoqi@0 | 125 | /** |
aoqi@0 | 126 | * Print warning message, increment warning count. |
aoqi@0 | 127 | * |
aoqi@0 | 128 | * @param pos the position of the source |
aoqi@0 | 129 | * @param msg message to print |
aoqi@0 | 130 | */ |
aoqi@0 | 131 | private void printWarning(SourcePosition pos, String msg) { |
aoqi@0 | 132 | configuration.root.printWarning(pos, msg); |
aoqi@0 | 133 | } |
aoqi@0 | 134 | |
aoqi@0 | 135 | /** |
aoqi@0 | 136 | * Print warning message, increment warning count. |
aoqi@0 | 137 | * |
aoqi@0 | 138 | * @param msg message to print |
aoqi@0 | 139 | */ |
aoqi@0 | 140 | private void printWarning(String msg) { |
aoqi@0 | 141 | configuration.root.printWarning(msg); |
aoqi@0 | 142 | } |
aoqi@0 | 143 | |
aoqi@0 | 144 | /** |
aoqi@0 | 145 | * Print a message. |
aoqi@0 | 146 | * |
aoqi@0 | 147 | * @param pos the position of the source |
aoqi@0 | 148 | * @param msg message to print |
aoqi@0 | 149 | */ |
aoqi@0 | 150 | private void printNotice(SourcePosition pos, String msg) { |
aoqi@0 | 151 | configuration.root.printNotice(pos, msg); |
aoqi@0 | 152 | } |
aoqi@0 | 153 | |
aoqi@0 | 154 | /** |
aoqi@0 | 155 | * Print a message. |
aoqi@0 | 156 | * |
aoqi@0 | 157 | * @param msg message to print |
aoqi@0 | 158 | */ |
aoqi@0 | 159 | private void printNotice(String msg) { |
aoqi@0 | 160 | configuration.root.printNotice(msg); |
aoqi@0 | 161 | } |
aoqi@0 | 162 | |
aoqi@0 | 163 | /** |
aoqi@0 | 164 | * Print error message, increment error count. |
aoqi@0 | 165 | * |
aoqi@0 | 166 | * @param pos the position of the source |
aoqi@0 | 167 | * @param key selects message from resource |
aoqi@0 | 168 | * @param args arguments to be replaced in the message. |
aoqi@0 | 169 | */ |
aoqi@0 | 170 | public void error(SourcePosition pos, String key, Object... args) { |
aoqi@0 | 171 | printError(pos, getText(key, args)); |
aoqi@0 | 172 | } |
aoqi@0 | 173 | |
aoqi@0 | 174 | /** |
aoqi@0 | 175 | * Print error message, increment error count. |
aoqi@0 | 176 | * |
aoqi@0 | 177 | * @param key selects message from resource |
aoqi@0 | 178 | * @param args arguments to be replaced in the message. |
aoqi@0 | 179 | */ |
aoqi@0 | 180 | public void error(String key, Object... args) { |
aoqi@0 | 181 | printError(getText(key, args)); |
aoqi@0 | 182 | } |
aoqi@0 | 183 | |
aoqi@0 | 184 | /** |
aoqi@0 | 185 | * Print warning message, increment warning count. |
aoqi@0 | 186 | * |
aoqi@0 | 187 | * @param pos the position of the source |
aoqi@0 | 188 | * @param key selects message from resource |
aoqi@0 | 189 | * @param args arguments to be replaced in the message. |
aoqi@0 | 190 | */ |
aoqi@0 | 191 | public void warning(SourcePosition pos, String key, Object... args) { |
aoqi@0 | 192 | if (configuration.showMessage(pos, key)) |
aoqi@0 | 193 | printWarning(pos, getText(key, args)); |
aoqi@0 | 194 | } |
aoqi@0 | 195 | |
aoqi@0 | 196 | /** |
aoqi@0 | 197 | * Print warning message, increment warning count. |
aoqi@0 | 198 | * |
aoqi@0 | 199 | * @param key selects message from resource |
aoqi@0 | 200 | * @param args arguments to be replaced in the message. |
aoqi@0 | 201 | */ |
aoqi@0 | 202 | public void warning(String key, Object... args) { |
aoqi@0 | 203 | printWarning(getText(key, args)); |
aoqi@0 | 204 | } |
aoqi@0 | 205 | |
aoqi@0 | 206 | /** |
aoqi@0 | 207 | * Print a message. |
aoqi@0 | 208 | * |
aoqi@0 | 209 | * @param pos the position of the source |
aoqi@0 | 210 | * @param key selects message from resource |
aoqi@0 | 211 | * @param args arguments to be replaced in the message. |
aoqi@0 | 212 | */ |
aoqi@0 | 213 | public void notice(SourcePosition pos, String key, Object... args) { |
aoqi@0 | 214 | printNotice(pos, getText(key, args)); |
aoqi@0 | 215 | } |
aoqi@0 | 216 | |
aoqi@0 | 217 | /** |
aoqi@0 | 218 | * Print a message. |
aoqi@0 | 219 | * |
aoqi@0 | 220 | * @param key selects message from resource |
aoqi@0 | 221 | * @param args arguments to be replaced in the message. |
aoqi@0 | 222 | */ |
aoqi@0 | 223 | public void notice(String key, Object... args) { |
aoqi@0 | 224 | printNotice(getText(key, args)); |
aoqi@0 | 225 | } |
aoqi@0 | 226 | } |