duke@1: /*
jjg@1357:  * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: package com.sun.tools.doclets.internal.toolkit.util;
duke@1: 
jjg@1357: import java.text.MessageFormat;
jjg@1357: import java.util.*;
jjg@1357: 
duke@1: import com.sun.javadoc.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.Configuration;
duke@1: 
duke@1: 
duke@1: /**
duke@1:  * Retrieve and format messages stored in a resource.
duke@1:  *
duke@1:  * This code is not part of an API.
duke@1:  * It is implementation that is subject to change.
duke@1:  * Do not use it as an API
duke@1:  *
duke@1:  * @since 1.2
duke@1:  * @author Atul M Dambalkar
duke@1:  * @author Robert Field
duke@1:  */
duke@1: public class MessageRetriever {
duke@1:     /**
duke@1:      * The global configuration information for this run.
duke@1:      */
duke@1:     private final Configuration configuration;
duke@1: 
duke@1:     /**
duke@1:      * The location from which to lazily fetch the resource..
duke@1:      */
duke@1:     private final String resourcelocation;
duke@1: 
duke@1:     /**
duke@1:      * The lazily fetched resource..
duke@1:      */
duke@1:     private ResourceBundle messageRB;
duke@1: 
duke@1:     /**
duke@1:      * Initilize the ResourceBundle with the given resource.
duke@1:      *
duke@1:      * @param rb the esource bundle to read.
duke@1:      */
duke@1:     public MessageRetriever(ResourceBundle rb) {
duke@1:         this.configuration = null;
duke@1:         this.messageRB = rb;
duke@1:         this.resourcelocation = null;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Initilize the ResourceBundle with the given resource.
duke@1:      *
duke@1:      * @param configuration the configuration
duke@1:      * @param resourcelocation Resource.
duke@1:      */
duke@1:     public MessageRetriever(Configuration configuration,
duke@1:                             String resourcelocation) {
duke@1:         this.configuration = configuration;
duke@1:         this.resourcelocation = resourcelocation;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Get and format message string from resource
duke@1:      *
duke@1:      * @param key selects message from resource
jjg@192:      * @param args arguments to be replaced in the message.
duke@1:      * @throws MissingResourceException when the key does not
duke@1:      * exist in the properties file.
duke@1:      */
jjg@192:     public String getText(String key, Object... args) throws MissingResourceException {
duke@1:         if (messageRB == null) {
duke@1:             try {
duke@1:                 messageRB = ResourceBundle.getBundle(resourcelocation);
duke@1:             } catch (MissingResourceException e) {
duke@1:                 throw new Error("Fatal: Resource (" + resourcelocation +
duke@1:                                     ") for javadoc doclets is missing.");
duke@1:             }
duke@1:         }
duke@1:         String message = messageRB.getString(key);
jjg@192:         return MessageFormat.format(message, args);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print error message, increment error count.
duke@1:      *
duke@1:      * @param pos the position of the source
duke@1:      * @param msg message to print
duke@1:      */
duke@1:     private void printError(SourcePosition pos, String msg) {
duke@1:         configuration.root.printError(pos, msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print error message, increment error count.
duke@1:      *
duke@1:      * @param msg message to print
duke@1:      */
duke@1:     private void printError(String msg) {
duke@1:         configuration.root.printError(msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print warning message, increment warning count.
duke@1:      *
duke@1:      * @param pos the position of the source
duke@1:      * @param msg message to print
duke@1:      */
duke@1:     private void printWarning(SourcePosition pos, String msg) {
duke@1:         configuration.root.printWarning(pos, msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print warning message, increment warning count.
duke@1:      *
duke@1:      * @param msg message to print
duke@1:      */
duke@1:     private void printWarning(String msg) {
duke@1:         configuration.root.printWarning(msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print a message.
duke@1:      *
duke@1:      * @param pos the position of the source
duke@1:      * @param msg message to print
duke@1:      */
duke@1:     private void printNotice(SourcePosition pos, String msg) {
duke@1:         configuration.root.printNotice(pos, msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print a message.
duke@1:      *
duke@1:      * @param msg message to print
duke@1:      */
duke@1:     private void printNotice(String msg) {
duke@1:         configuration.root.printNotice(msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print error message, increment error count.
duke@1:      *
duke@1:      * @param pos the position of the source
duke@1:      * @param key selects message from resource
jjg@192:      * @param args arguments to be replaced in the message.
duke@1:      */
jjg@192:     public void error(SourcePosition pos, String key, Object... args) {
jjg@192:         printError(pos, getText(key, args));
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print error message, increment error count.
duke@1:      *
duke@1:      * @param key selects message from resource
jjg@192:      * @param args arguments to be replaced in the message.
duke@1:      */
jjg@192:     public void error(String key, Object... args) {
jjg@192:         printError(getText(key, args));
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print warning message, increment warning count.
duke@1:      *
duke@1:      * @param pos the position of the source
duke@1:      * @param key selects message from resource
jjg@192:      * @param args arguments to be replaced in the message.
duke@1:      */
jjg@192:     public void warning(SourcePosition pos, String key, Object... args) {
jjg@192:         printWarning(pos, getText(key, args));
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print warning message, increment warning count.
duke@1:      *
duke@1:      * @param key selects message from resource
jjg@192:      * @param args arguments to be replaced in the message.
duke@1:      */
jjg@192:     public void warning(String key, Object... args) {
jjg@192:         printWarning(getText(key, args));
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print a message.
duke@1:      *
duke@1:      * @param pos the position of the source
duke@1:      * @param key selects message from resource
jjg@192:      * @param args arguments to be replaced in the message.
duke@1:      */
jjg@192:     public void notice(SourcePosition pos, String key, Object... args) {
jjg@192:         printNotice(pos, getText(key, args));
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print a message.
duke@1:      *
duke@1:      * @param key selects message from resource
jjg@192:      * @param args arguments to be replaced in the message.
duke@1:      */
jjg@192:     public void notice(String key, Object... args) {
jjg@192:         printNotice(getText(key, args));
duke@1:     }
duke@1: }