1. /*
  2. * @(#)DocErrorReporter.java 1.8 02/10/06
  3. *
  4. * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
  5. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
  6. */
  7. package com.sun.javadoc;
  8. /**
  9. * This interface provides error, warning and notice printing.
  10. *
  11. * @since JDK1.2
  12. * @author Robert Field
  13. */
  14. public interface DocErrorReporter {
  15. /**
  16. * Print error message and increment error count.
  17. *
  18. * @param msg message to print
  19. */
  20. void printError(String msg);
  21. /**
  22. * Print an error message and increment error count.
  23. *
  24. * @param pos the position item where the error occurs
  25. * @param msg message to print
  26. * @since 1.4
  27. */
  28. void printError(SourcePosition pos, String msg);
  29. /**
  30. * Print warning message and increment warning count.
  31. *
  32. * @param msg message to print
  33. */
  34. void printWarning(String msg);
  35. /**
  36. * Print warning message and increment warning count.
  37. *
  38. * @param pos the position item where the warning occurs
  39. * @param msg message to print
  40. * @since 1.4
  41. */
  42. void printWarning(SourcePosition pos, String msg);
  43. /**
  44. * Print a message.
  45. *
  46. * @param msg message to print
  47. */
  48. void printNotice(String msg);
  49. /**
  50. * Print a message.
  51. *
  52. * @param pos the position item where the message occurs
  53. * @param msg message to print
  54. * @since 1.4
  55. */
  56. void printNotice(SourcePosition pos, String msg);
  57. }