|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.tools.xjc.Plugin
com.sun.tools.xjc.addon.locator.SourceLocationAddOn
public class SourceLocationAddOn
Generates JAXB objects that implement Locatable
.
Constructor Summary | |
---|---|
SourceLocationAddOn()
|
Method Summary | |
---|---|
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 outline,
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 |
---|
public SourceLocationAddOn()
Method Detail |
---|
public String getOptionName()
Plugin
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.
getOptionName
in class Plugin
public String getUsage()
Plugin
getUsage
in class Plugin
public int parseArgument(Options opt, String[] args, int i) throws BadCommandLineException, IOException
Plugin
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.
parseArgument
in class Plugin
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
public boolean run(Outline outline, Options opt, ErrorHandler errorHandler)
Plugin
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.
run
in class Plugin
outline
- This object allows access to various generated code.errorHandler
- Errors should be reported to this handler.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |