Package wt.annotations.processors

Class MBeanInterfaceProcessor

java.lang.Object
javax.annotation.processing.AbstractProcessor
wt.annotations.processors.MBeanInterfaceProcessor
All Implemented Interfaces:
Processor
@SupportedAnnotationTypes("*") public final class MBeanInterfaceProcessor extends AbstractProcessor
Annotation processor which processes JMX MBean interfaces to provide additional metadata beyond that provided by Java 6's StandardMBean.

Specifically, this class will produce a corresponding xxxMBeanResource.rbInfo file for any xxxMBean.java source file which contains a Java interface (as opposed to a class). The .rbInfo file will define resource bundle entries containing descriptions of the interface, its methods, and the methods' parameters as well as the formal names of the method parameters. The descriptions are derived from the Javadoc for the interface, method, or parameter in question. For interface or method descriptions, the description will contain Javadoc up to (but not including) the first HTML or Javadoc markup character or the entire Javadoc comment, whichever comes first. For parameter descriptions, the description will contain the first line of Javadoc for the given parameter. If this process results in an empty .rbInfo dataset, then no file is written.

Annotation Processor's like this class are essentially plug-ins for javac. See http://java.sun.com/javase/6/docs/technotes/guides/javac/index.html for further details on javac and its usage.

When using this class with javac, be sure both this class and wt.jmx.resources.MBeanRBUtility (which this class depends upon) are visible to javac via either the classpath or the -processorpath command line option.

Supported API: true

Extendable: false