() {
duke@1: public Log make() {
duke@1: return new Messager(context,
duke@1: programName,
duke@1: errWriter,
duke@1: warnWriter,
duke@1: noticeWriter);
duke@1: }
duke@1: });
duke@1: }
duke@1:
duke@1: public class ExitJavadoc extends Error {
duke@1: private static final long serialVersionUID = 0;
duke@1: }
duke@1:
duke@1: private final String programName;
duke@1:
duke@1: private ResourceBundle messageRB = null;
duke@1:
duke@1: /** The default writer for diagnostics
duke@1: */
duke@1: static final PrintWriter defaultErrWriter = new PrintWriter(System.err);
duke@1: static final PrintWriter defaultWarnWriter = new PrintWriter(System.err);
duke@1: static final PrintWriter defaultNoticeWriter = new PrintWriter(System.out);
duke@1:
duke@1: /**
duke@1: * Constructor
duke@1: * @param programName Name of the program (for error messages).
duke@1: */
duke@1: protected Messager(Context context, String programName) {
duke@1: this(context, programName, defaultErrWriter, defaultWarnWriter, defaultNoticeWriter);
duke@1: }
duke@1:
duke@1: /**
duke@1: * Constructor
duke@1: * @param programName Name of the program (for error messages).
duke@1: * @param errWriter Stream for error messages
duke@1: * @param warnWriter Stream for warnings
duke@1: * @param noticeWriter Stream for other messages
duke@1: */
jjg@198: @SuppressWarnings("deprecation")
duke@1: protected Messager(Context context,
duke@1: String programName,
duke@1: PrintWriter errWriter,
duke@1: PrintWriter warnWriter,
duke@1: PrintWriter noticeWriter) {
duke@1: super(context, errWriter, warnWriter, noticeWriter);
duke@1: this.programName = programName;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Reset resource bundle, eg. locale has changed.
duke@1: */
duke@1: public void reset() {
duke@1: messageRB = null;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Get string from ResourceBundle, initialize ResourceBundle
duke@1: * if needed.
duke@1: */
duke@1: private String getString(String key) {
duke@1: ResourceBundle messageRB = this.messageRB;
duke@1: if (messageRB == null) {
duke@1: try {
duke@1: this.messageRB = messageRB =
duke@1: ResourceBundle.getBundle(
duke@1: "com.sun.tools.javadoc.resources.javadoc");
duke@1: } catch (MissingResourceException e) {
duke@1: throw new Error("Fatal: Resource for javadoc is missing");
duke@1: }
duke@1: }
duke@1: return messageRB.getString(key);
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
duke@1: */
duke@1: String getText(String key) {
duke@1: return getText(key, (String)null);
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
duke@1: * @param a1 first argument
duke@1: */
duke@1: String getText(String key, String a1) {
duke@1: return getText(key, a1, null);
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
duke@1: * @param a1 first argument
duke@1: * @param a2 second argument
duke@1: */
duke@1: String getText(String key, String a1, String a2) {
duke@1: return getText(key, a1, a2, null);
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
duke@1: * @param a1 first argument
duke@1: * @param a2 second argument
duke@1: * @param a3 third argument
duke@1: */
duke@1: String getText(String key, String a1, String a2, String a3) {
duke@1: return getText(key, a1, a2, a3, null);
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
duke@1: * @param a1 first argument
duke@1: * @param a2 second argument
duke@1: * @param a3 third argument
duke@1: * @param a4 fourth argument
duke@1: */
duke@1: String getText(String key, String a1, String a2, String a3,
duke@1: String a4) {
duke@1: try {
duke@1: String message = getString(key);
duke@1: String[] args = new String[4];
duke@1: args[0] = a1;
duke@1: args[1] = a2;
duke@1: args[2] = a3;
duke@1: args[3] = a4;
duke@1: return MessageFormat.format(message, (Object[])args);
duke@1: } catch (MissingResourceException e) {
duke@1: return "********** Resource for javadoc is broken. There is no " +
duke@1: key + " key in resource.";
duke@1: }
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print error message, increment error count.
duke@1: * Part of DocErrorReporter.
duke@1: *
duke@1: * @param msg message to print
duke@1: */
duke@1: public void printError(String msg) {
duke@1: printError(null, msg);
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print error message, increment error count.
duke@1: * Part of DocErrorReporter.
duke@1: *
duke@1: * @param pos the position where the error occurs
duke@1: * @param msg message to print
duke@1: */
duke@1: public void printError(SourcePosition pos, String msg) {
duke@1: String prefix = (pos == null) ? programName : pos.toString();
duke@1: errWriter.println(prefix + ": " + getText("javadoc.error") + " - " + msg);
duke@1: errWriter.flush();
duke@1: prompt();
duke@1: nerrors++;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print warning message, increment warning count.
duke@1: * Part of DocErrorReporter.
duke@1: *
duke@1: * @param msg message to print
duke@1: */
duke@1: public void printWarning(String msg) {
duke@1: printWarning(null, msg);
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print warning message, increment warning count.
duke@1: * Part of DocErrorReporter.
duke@1: *
duke@1: * @param pos the position where the error occurs
duke@1: * @param msg message to print
duke@1: */
duke@1: public void printWarning(SourcePosition pos, String msg) {
duke@1: String prefix = (pos == null) ? programName : pos.toString();
duke@1: warnWriter.println(prefix + ": " + getText("javadoc.warning") +" - " + msg);
duke@1: warnWriter.flush();
duke@1: nwarnings++;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print a message.
duke@1: * Part of DocErrorReporter.
duke@1: *
duke@1: * @param msg message to print
duke@1: */
duke@1: public void printNotice(String msg) {
duke@1: printNotice(null, msg);
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print a message.
duke@1: * Part of DocErrorReporter.
duke@1: *
duke@1: * @param pos the position where the error occurs
duke@1: * @param msg message to print
duke@1: */
duke@1: public void printNotice(SourcePosition pos, String msg) {
duke@1: if (pos == null)
duke@1: noticeWriter.println(msg);
duke@1: else
duke@1: noticeWriter.println(pos + ": " + msg);
duke@1: noticeWriter.flush();
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print error message, increment error count.
duke@1: *
duke@1: * @param key selects message from resource
duke@1: */
duke@1: public void error(SourcePosition pos, String key) {
duke@1: printError(pos, getText(key));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print error message, increment error count.
duke@1: *
duke@1: * @param key selects message from resource
duke@1: * @param a1 first argument
duke@1: */
duke@1: public void error(SourcePosition pos, String key, String a1) {
duke@1: printError(pos, getText(key, a1));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print error message, increment error count.
duke@1: *
duke@1: * @param key selects message from resource
duke@1: * @param a1 first argument
duke@1: * @param a2 second argument
duke@1: */
duke@1: public void error(SourcePosition pos, String key, String a1, String a2) {
duke@1: printError(pos, getText(key, a1, a2));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print error message, increment error count.
duke@1: *
duke@1: * @param key selects message from resource
duke@1: * @param a1 first argument
duke@1: * @param a2 second argument
duke@1: * @param a3 third argument
duke@1: */
duke@1: public void error(SourcePosition pos, String key, String a1, String a2, String a3) {
duke@1: printError(pos, getText(key, a1, a2, a3));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print warning message, increment warning count.
duke@1: *
duke@1: * @param key selects message from resource
duke@1: */
duke@1: public void warning(SourcePosition pos, String key) {
duke@1: printWarning(pos, getText(key));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print warning message, increment warning count.
duke@1: *
duke@1: * @param key selects message from resource
duke@1: * @param a1 first argument
duke@1: */
duke@1: public void warning(SourcePosition pos, String key, String a1) {
duke@1: printWarning(pos, getText(key, a1));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print warning message, increment warning count.
duke@1: *
duke@1: * @param key selects message from resource
duke@1: * @param a1 first argument
duke@1: * @param a2 second argument
duke@1: */
duke@1: public void warning(SourcePosition pos, String key, String a1, String a2) {
duke@1: printWarning(pos, getText(key, a1, a2));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print warning message, increment warning count.
duke@1: *
duke@1: * @param key selects message from resource
duke@1: * @param a1 first argument
duke@1: * @param a2 second argument
duke@1: * @param a3 third argument
duke@1: */
duke@1: public void warning(SourcePosition pos, String key, String a1, String a2, String a3) {
duke@1: printWarning(pos, getText(key, a1, a2, a3));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print warning message, increment warning count.
duke@1: *
duke@1: * @param key selects message from resource
duke@1: * @param a1 first argument
duke@1: * @param a2 second argument
duke@1: * @param a3 third argument
duke@1: */
duke@1: public void warning(SourcePosition pos, String key, String a1, String a2, String a3,
duke@1: String a4) {
duke@1: printWarning(pos, getText(key, a1, a2, a3, a4));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print a message.
duke@1: *
duke@1: * @param key selects message from resource
duke@1: */
duke@1: public void notice(String key) {
duke@1: printNotice(getText(key));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print a message.
duke@1: *
duke@1: * @param key selects message from resource
duke@1: * @param a1 first argument
duke@1: */
duke@1: public void notice(String key, String a1) {
duke@1: printNotice(getText(key, a1));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print a message.
duke@1: *
duke@1: * @param key selects message from resource
duke@1: * @param a1 first argument
duke@1: * @param a2 second argument
duke@1: */
duke@1: public void notice(String key, String a1, String a2) {
duke@1: printNotice(getText(key, a1, a2));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Print a message.
duke@1: *
duke@1: * @param key selects message from resource
duke@1: * @param a1 first argument
duke@1: * @param a2 second argument
duke@1: * @param a3 third argument
duke@1: */
duke@1: public void notice(String key, String a1, String a2, String a3) {
duke@1: printNotice(getText(key, a1, a2, a3));
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return total number of errors, including those recorded
duke@1: * in the compilation log.
duke@1: */
duke@1: public int nerrors() { return nerrors; }
duke@1:
duke@1: /**
duke@1: * Return total number of warnings, including those recorded
duke@1: * in the compilation log.
duke@1: */
duke@1: public int nwarnings() { return nwarnings; }
duke@1:
duke@1: /**
duke@1: * Print exit message.
duke@1: */
duke@1: public void exitNotice() {
duke@1: int nerrors = nerrors();
duke@1: int nwarnings = nwarnings();
duke@1: if (nerrors > 0) {
duke@1: notice((nerrors > 1) ? "main.errors" : "main.error",
duke@1: "" + nerrors);
duke@1: }
duke@1: if (nwarnings > 0) {
duke@1: notice((nwarnings > 1) ? "main.warnings" : "main.warning",
duke@1: "" + nwarnings);
duke@1: }
duke@1: }
duke@1:
duke@1: /**
duke@1: * Force program exit, e.g., from a fatal error.
duke@1: *
duke@1: * TODO: This method does not really belong here.
duke@1: */
duke@1: public void exit() {
duke@1: throw new ExitJavadoc();
duke@1: }
duke@1:
duke@1: }