JAXB OSGI 4.0.9 · com.sun.tools.xjc.Plugin · APIdia, the JavaDoc alternative

Access	Constructor and Description
protected	Plugin() Default constructor.

Method Summary

Modifier and Type	Method and Description
public List<String>	Returns: can be empty, be never be null. getCustomizationURIs() Returns the list of namespace URIs that are supported by this plug-in as schema annotations.
public abstract String	getOptionName() Gets the option name to turn on this add-on.
public abstract String	Returns: localized description message. should be terminated by \n. getUsage() Gets the description of this add-on.
public boolean	isCustomizationTagName(String the namespace URI of the element. Never null. nsUri, String the local name of the element. Never null. localName) Checks if the given tag name is a valid tag name for the customization element in this plug-in. This method is invoked by XJC to determine if the user-specified customization element is really a customization or not.
public void	onActivated(Options opts) Notifies a plugin that it's activated.
public int	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.) 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.
public void	postProcessModel(Model The object that represents the classes/properties to be generated. model, ErrorHandler Errors should be reported to this handler. errorHandler) Performs the post-processing of the `Model`.
public abstract boolean	Returns: If the add-on executes successfully, return true. If it detects some errors but those are reported and recovered gracefully, return false. run(Outline This object allows access to various generated code. outline, Options opt, ErrorHandler Errors should be reported to this handler. errorHandler) Run the add-on.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Plugin	back to summary
protected Plugin() Default constructor.

Method Detail

getCustomizationURIs	back to summary
public List<String> getCustomizationURIs() Returns the list of namespace URIs that are supported by this plug-in as schema annotations. If a plug-in returns a non-empty list, the JAXB RI will recognize these namespace URIs as vendor extensions (much like "http://java.sun.com/xml/ns/jaxb/xjc"). This allows users to write those annotations inside a schema, or in external binding files, and later plug-ins can access those annotations as DOM nodes. See http://java.sun.com/webservices/docs/1.5/jaxb/vendorCustomizations.html for the syntax that users need to use to enable extension URIs. Returns:List<String> can be empty, be never be null.

getCustomizationURIs

back to summary

public List<String> getCustomizationURIs()

Returns the list of namespace URIs that are supported by this plug-in as schema annotations.

If a plug-in returns a non-empty list, the JAXB RI will recognize these namespace URIs as vendor extensions (much like "http://java.sun.com/xml/ns/jaxb/xjc"). This allows users to write those annotations inside a schema, or in external binding files, and later plug-ins can access those annotations as DOM nodes.

See http://java.sun.com/webservices/docs/1.5/jaxb/vendorCustomizations.html for the syntax that users need to use to enable extension URIs.

Returns:List<String>: can be empty, be never be null.

getOptionName back to summary

getOptionName	back to summary
public abstract String getOptionName() 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 `parseArgument(Options, String[], int)`, allowing plugins to handle arguments to this option.

public abstract String getOptionName()

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 parseArgument(Options, String[], int), allowing plugins to handle arguments to this option.

getUsage	back to summary
public abstract String getUsage() Gets the description of this add-on. Used to generate a usage screen. Returns:String localized description message. should be terminated by \n.

getUsage

back to summary

public abstract String getUsage()

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

Returns:String: localized description message. should be terminated by \n.

isCustomizationTagName back to summary

isCustomizationTagName	back to summary
public boolean isCustomizationTagName(String nsUri, String localName) Checks if the given tag name is a valid tag name for the customization element in this plug-in. This method is invoked by XJC to determine if the user-specified customization element is really a customization or not. This information is used to pick the proper error message. A plug-in is still encouraged to do the validation of the customization element in the `run` method before using any `CPluginCustomization`, to make sure that it has proper child elements and attributes. Parameters nsUri:String the namespace URI of the element. Never null. localName:String the local name of the element. Never null.

public boolean isCustomizationTagName(String nsUri, String localName)

Checks if the given tag name is a valid tag name for the customization element in this plug-in.

This method is invoked by XJC to determine if the user-specified customization element is really a customization or not. This information is used to pick the proper error message.

A plug-in is still encouraged to do the validation of the customization element in the run method before using any CPluginCustomization, to make sure that it has proper child elements and attributes.

Parameters

nsUri:String: the namespace URI of the element. Never null.
localName:String: the local name of the element. Never null.

onActivated back to summary

onActivated	back to summary
public void onActivated(Options opts) throws BadCommandLineException Notifies a plugin that it's activated. This method is called when a plugin is activated through the command line option (as specified by `getOptionName()`. This is a good opportunity to use `Options#setFieldRendererFactory(FieldRendererFactory, Plugin)` if a plugin so desires. Noop by default. Since JAXB 2.0 EA4

public void onActivated(Options opts) throws BadCommandLineException

Notifies a plugin that it's activated.

This method is called when a plugin is activated through the command line option (as specified by getOptionName().

This is a good opportunity to use Options#setFieldRendererFactory(FieldRendererFactory, Plugin) if a plugin so desires.

Noop by default.

Since: JAXB 2.0 EA4

parseArgument back to summary

parseArgument	back to summary
public int parseArgument(Options opt, String[] args, int i) throws BadCommandLineException, IOException 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 needs to be activated to participate in further processing. Returns:int 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.) Exceptions 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.

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

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 needs to be activated to participate in further processing.

Returns:int

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

Exceptions

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.

postProcessModel back to summary

postProcessModel	back to summary
public void postProcessModel(Model model, ErrorHandler errorHandler) Performs the post-processing of the `Model`. This method is invoked after XJC has internally finished the model construction. This is a chance for a plugin to affect the way code generation is performed. Compared to the `run(Outline, Options, ErrorHandler)` method, this method allows a plugin to work at the higher level conceptually closer to the abstract JAXB model, as opposed to Java syntax level. Note that this method is invoked only when a is activated. Parameters model:Model The object that represents the classes/properties to be generated. errorHandler:ErrorHandler Errors should be reported to this handler. Since JAXB 2.0.2

public void postProcessModel(Model model, ErrorHandler errorHandler)

Performs the post-processing of the Model.

This method is invoked after XJC has internally finished the model construction. This is a chance for a plugin to affect the way code generation is performed.

Compared to the run(Outline, Options, ErrorHandler) method, this method allows a plugin to work at the higher level conceptually closer to the abstract JAXB model, as opposed to Java syntax level.

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

Parameters

model:Model: The object that represents the classes/properties to be generated.
errorHandler:ErrorHandler: Errors should be reported to this handler.

Since

JAXB 2.0.2

run back to summary

run	back to summary
public abstract boolean run(Outline outline, Options opt, ErrorHandler errorHandler) throws SAXException 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 is activated. Parameters outline:Outline This object allows access to various generated code. errorHandler:ErrorHandler Errors should be reported to this handler. Returns:boolean If the add-on executes successfully, return true. If it detects some errors but those are reported and recovered gracefully, return false. Exceptions SAXException: After an error is reported to `ErrorHandler`, the same exception can be thrown to indicate a fatal irrecoverable error. `ErrorHandler` itself may throw it, if it chooses not to recover from the error.

public abstract boolean run(Outline outline, Options opt, ErrorHandler errorHandler) throws SAXException

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 is activated.

Parameters

outline:Outline: This object allows access to various generated code.
errorHandler:ErrorHandler: Errors should be reported to this handler.

Returns:boolean

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

Exceptions

SAXException:: After an error is reported to ErrorHandler, the same exception can be thrown to indicate a fatal irrecoverable error. ErrorHandler itself may throw it, if it chooses not to recover from the error.

public abstract Class Plugin

Constructor Summary

Method Summary

Constructor Detail

Method Detail