Package com.sun.tools.xjc.addon.at_generated

Class PluginImpl

java.lang.Object
com.sun.tools.xjc.Plugin
com.sun.tools.xjc.addon.at_generated.PluginImpl
public class PluginImpl extends Plugin
Plugin that marks the generated code by using JSR-250's '@Generated'.
Author:
Kohsuke Kawaguchi

  • Constructor Details

    • PluginImpl

      public PluginImpl()

  • Method Details

    • 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.

    • 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.