Class PluginImpl
Plugin
that marks the generated code by using '@Generated'.- Author:
- Kohsuke Kawaguchi, Lukas Jungmann
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the option name to turn on this add-on.getUsage()
Gets the description of this add-on.int
parseArgument
(Options opt, String[] args, int i) Parses an optionargs[i]
and augment theopt
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
-
Constructor Details
-
PluginImpl
public PluginImpl()
-
-
Method Details
-
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 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 classPlugin
-
getUsage
Description copied from class:Plugin
Gets the description of this add-on. Used to generate a usage screen. -
parseArgument
public int parseArgument(Options opt, String[] args, int i) throws BadCommandLineException, IOException Description copied from class:Plugin
Parses an optionargs[i]
and augment theopt
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
Plugin.getOptionName()
. But nevertheless a needs to be activated to participate in further processing.- Overrides:
parseArgument
in classPlugin
- 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
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
andOptions
.Note that this method is invoked only when a is activated.
- Specified by:
run
in classPlugin
- 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.
-