wt.annotations.processors
Class MBeanProcessorFactory

java.lang.Object
  wt.annotations.processors.MBeanProcessorFactory

public final class MBeanProcessorFactory
extends Object

Annotation processory factory which processes JMX MBean interfaces to provide additional metadata beyond that provided by Java 5'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 factories, like this class are essentially plug-ins for Java 5's annotation processor tool, apt. See http://java.sun.com/j2se/1.5.0/docs/guide/apt/index.html for further details on APT and its usage. In particular note http://java.sun.com/j2se/1.5.0/docs/tooldocs/share/apt.html which provides details on using apt from the command line including syntax for specifying annotation processor factories like this class.

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

Supported API: true

Extendable: false

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait