1 /* 2 * Copyright (c) 1998, 2006, 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.javadoc; 27 28 import com.google.doclava.annotation.Unused; 29 30 /** 31 * This interface provides error, warning and notice printing. 32 * 33 * @since 1.2 34 * @author Robert Field 35 */ 36 public interface DocErrorReporter { 37 38 /** 39 * Print error message and increment error count. 40 * 41 * @param msg message to print 42 */ 43 @Unused printError(String msg)44 void printError(String msg); 45 46 /** 47 * Print an error message and increment error count. 48 * 49 * @param pos the position item where the error occurs 50 * @param msg message to print 51 * @since 1.4 52 */ 53 @Unused printError(SourcePosition pos, String msg)54 void printError(SourcePosition pos, String msg); 55 56 /** 57 * Print warning message and increment warning count. 58 * 59 * @param msg message to print 60 */ 61 @Unused printWarning(String msg)62 void printWarning(String msg); 63 64 /** 65 * Print warning message and increment warning count. 66 * 67 * @param pos the position item where the warning occurs 68 * @param msg message to print 69 * @since 1.4 70 */ 71 @Unused printWarning(SourcePosition pos, String msg)72 void printWarning(SourcePosition pos, String msg); 73 74 /** 75 * Print a message. 76 * 77 * @param msg message to print 78 */ 79 @Unused printNotice(String msg)80 void printNotice(String msg); 81 82 /** 83 * Print a message. 84 * 85 * @param pos the position item where the message occurs 86 * @param msg message to print 87 * @since 1.4 88 */ 89 @Unused printNotice(SourcePosition pos, String msg)90 void printNotice(SourcePosition pos, String msg); 91 } 92