com.sun.tools.xjc.addon.accessors

Class PluginImpl

java.lang.Object

com.sun.tools.xjc.Plugin

com.sun.tools.xjc.addon.accessors.PluginImpl

public class PluginImpl
extends Plugin

Generates synchronized methods.

Author:

Martin Grebac (martin.grebac@sun.com)

Constructor Summary

Constructors

Constructor and Description
PluginImpl()

Method Summary

Methods

Modifier and Type	Method and Description
String	getOptionName() Gets the option name to turn on this add-on.
String	getUsage() Gets the description of this add-on.
int	parseArgument(Options opt, String[] args, int i) Parses an option args[i] and augment the opt object appropriately, then return the number of tokens consumed.
boolean	run(Outline model, Options opt, ErrorHandler errorHandler) Run the add-on.

Methods inherited from class com.sun.tools.xjc.Plugin

getCustomizationURIs, isCustomizationTagName, onActivated, postProcessModel

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginImpl

public PluginImpl()

Method Detail

getOptionName

public String getOptionName()

Description copied from class: Plugin

Gets the option name to turn on this add-on.

For example, if "abc" is returned, "-abc" will turn on this plugin. A plugin needs to be turned on explicitly, or else no other methods of Plugin will be invoked.

Starting 2.1, when an option matches the name returned from this method, XJC will then invoke Plugin.parseArgument(Options, String[], int), allowing plugins to handle arguments to this option.

Specified by:

getOptionName in class Plugin

getUsage

public String getUsage()

Description copied from class: Plugin

Gets the description of this add-on. Used to generate a usage screen.

Specified by:

getUsage in class Plugin

Returns:

localized description message. should be terminated by \n.

parseArgument

public int parseArgument(Options opt,
                String[] args,
                int i)
                  throws BadCommandLineException,
                         IOException

Description copied from class: Plugin

Parses an option args[i] and augment the opt object appropriately, then return the number of tokens consumed.

The callee doesn't need to recognize the option that the getOptionName method returns.

Once a plugin is activated, this method is called for options that XJC didn't recognize. This allows a plugin to define additional options to customize its behavior.

Since options can appear in no particular order, XJC allows sub-options of a plugin to show up before the option that activates a plugin (one that's returned by #getOptionName().) But nevertheless a {@link Plugin} needs to be activated to participate in further processing.

Overrides:

parseArgument in class Plugin

Returns:

0 if the argument is not understood. Otherwise return the number of tokens that are consumed, including the option itself. (so if you have an option like "-foo 3", return 2.)

Throws:

BadCommandLineException - If the option was recognized but there's an error. This halts the argument parsing process and causes XJC to abort, reporting an error.

IOException

run

public boolean run(Outline model,
          Options opt,
          ErrorHandler errorHandler)

Description copied from class: Plugin

Run the add-on.

This method is invoked after XJC has internally finished the code generation. Plugins can tweak some of the generated code (or add more code) by using Outline and Options.

Note that this method is invoked only when a Plugin is activated.

Specified by:

run in class Plugin

Parameters:

model - This object allows access to various generated code.

errorHandler - Errors should be reported to this handler.

Returns:

If the add-on executes successfully, return true. If it detects some errors but those are reported and recovered gracefully, return false.