This add-on will be called after the default generation has finished. + * + * @author Lukas Jungmann + * @since 2.2.6 + */ +public abstract 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 {@link Plugin} + * will be invoked. + * + *
When an option matches the name returned from this method, WsImport
+ * will then invoke {@link #parseArgument(Options, String[], int)}, allowing
+ * plugins to handle arguments to this option.
+ */
+ public abstract String getOptionName();
+
+ /**
+ * Gets the description of this add-on. Used to generate a usage screen.
+ *
+ * @return localized description message. should be terminated by \n.
+ */
+ public abstract String getUsage();
+
+ /**
+ * 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 + * WsImport didn't recognize. This allows a plugin to define additional + * options to customize its behavior. + * + *
Since options can appear in no particular order, WsImport allows + * sub-options of a plugin to show up before the option that activates a + * plugin (one that's returned by {@link #getOptionName()}.) + * + * But nevertheless a {@link Plugin} needs to be activated to participate in + * further processing. + * + * @return 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.) + * @exception BadCommandLineException If the option was recognized but + * there's an error. This halts the argument parsing process and causes + * WsImport to abort, reporting an error. + */ + public int parseArgument(Options opt, String[] args, int i) throws BadCommandLineException, IOException { + return 0; + } + + /** + * Notifies a plugin that it's activated. + * + *
This method is called when a plugin is activated through the command + * line option (as specified by {@link #getOptionName()}. + * + *
Noop by default. + * + */ + public void onActivated(Options opts) throws BadCommandLineException { + // noop + } + + /** + * Run the add-on. + * + *
This method is invoked after WsImport has internally finished the + * code generation. Plugins can tweak some of the generated code (or add + * more code) by altering {@link JCodeModel} obtained from {@link WsimportOptions#getCodeModel() + * } according to the current + * {@link Model WSDL model} and {@link WsimportOptions}. + * + *
Note that this method is invoked only when a {@link Plugin} is + * activated. + * + * @param wsdlModel This object allows access to the WSDL model used for + * code generation. + * + * @param options This object allows access to various options used for code + * generation as well as access to the generated code. + * + * @param errorReceiver Errors should be reported to this handler. + * + * @return If the add-on executes successfully, return true. If it detects + * some errors but those are reported and recovered gracefully, return + * false. + * + * @throws SAXException After an error is reported to {@link ErrorReceiver}, + * the same exception can be thrown to indicate a fatal irrecoverable error. {@link ErrorReceiver} + * itself may throw it, if it chooses not to recover from the error. + */ + public abstract boolean run( + Model wsdlModel, WsimportOptions options, ErrorReceiver errorReceiver) throws SAXException; +}