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

Mon, 27 Sep 2010 14:20:39 -0700

author
jjg
date
Mon, 27 Sep 2010 14:20:39 -0700
changeset 695
3c9b64e55c5d
parent 581
f2fdd52e4e87
child 2525
2eb010b6cb22
permissions
-rw-r--r--

6877202: Elements.getDocComment() is not getting JavaDocComments
6861094: javac -Xprint <file> does not print comments
6985205: access to tree positions and doc comments may be lost across annotation processing rounds
Reviewed-by: darcy

mcimadamore@136 1 /*
ohair@554 2 * Copyright (c) 2008, 2009, Oracle and/or its affiliates. All rights reserved.
mcimadamore@136 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
mcimadamore@136 4 *
mcimadamore@136 5 * This code is free software; you can redistribute it and/or modify it
mcimadamore@136 6 * under the terms of the GNU General Public License version 2 only, as
ohair@554 7 * published by the Free Software Foundation. Oracle designates this
mcimadamore@136 8 * particular file as subject to the "Classpath" exception as provided
ohair@554 9 * by Oracle in the LICENSE file that accompanied this code.
mcimadamore@136 10 *
mcimadamore@136 11 * This code is distributed in the hope that it will be useful, but WITHOUT
mcimadamore@136 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
mcimadamore@136 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
mcimadamore@136 14 * version 2 for more details (a copy is included in the LICENSE file that
mcimadamore@136 15 * accompanied this code).
mcimadamore@136 16 *
mcimadamore@136 17 * You should have received a copy of the GNU General Public License version
mcimadamore@136 18 * 2 along with this work; if not, write to the Free Software Foundation,
mcimadamore@136 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
mcimadamore@136 20 *
ohair@554 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 22 * or visit www.oracle.com if you need additional information or have any
ohair@554 23 * questions.
mcimadamore@136 24 */
mcimadamore@136 25
mcimadamore@136 26 package com.sun.tools.javac.api;
mcimadamore@136 27
mcimadamore@136 28 import java.util.Locale;
mcimadamore@136 29 import java.util.MissingResourceException;
mcimadamore@136 30
mcimadamore@136 31 /**
mcimadamore@136 32 * This interface defines the minimum requirements in order to provide support
mcimadamore@136 33 * for localized formatted strings.
mcimadamore@136 34 *
jjg@581 35 * <p><b>This is NOT part of any supported API.
jjg@333 36 * If you write code that depends on this, you do so at your own risk.
jjg@333 37 * This code and its internal interfaces are subject to change or
jjg@333 38 * deletion without notice.</b>
jjg@333 39 *
mcimadamore@136 40 * @author Maurizio Cimadamore
mcimadamore@136 41 */
mcimadamore@136 42 public interface Messages {
mcimadamore@136 43
mcimadamore@136 44 /**
mcimadamore@136 45 * Add a new resource bundle to the list that is searched for localized messages.
mcimadamore@136 46 * @param bundleName the name to identify the resource bundle of localized messages.
mcimadamore@136 47 * @throws MissingResourceException if the given resource is not found
mcimadamore@136 48 */
mcimadamore@136 49 void add(String bundleName) throws MissingResourceException;
mcimadamore@136 50
mcimadamore@136 51 /**
mcimadamore@221 52 * Get a localized formatted string.
mcimadamore@136 53 * @param l locale in which the text is to be localized
mcimadamore@136 54 * @param key locale-independent message key
mcimadamore@136 55 * @param args misc message arguments
mcimadamore@136 56 * @return a localized formatted string
mcimadamore@136 57 */
mcimadamore@136 58 String getLocalizedString(Locale l, String key, Object... args);
mcimadamore@136 59 }

mercurial