Top Description Inners Fields Constructors Methods

com.sun.tools.xjc

public final Class Driver

Class Inheritance

extends Object

java.lang.Object
com.sun.tools.xjc.Driver

Imports

java.io.File, .FileOutputStream, .IOException, .OutputStream, .OutputStreamWriter, .PrintStream, java.security.AccessController, .PrivilegedAction, java.util.Iterator, .Map.Entry, com.sun.codemodel.CodeWriter, .JCodeModel, com.sun.codemodel.writer.ZipCodeWriter, com.sun.istack.NotNull, .Nullable, com.sun.istack.tools.DefaultAuthenticator, com.sun.tools.xjc.generator.bean.BeanGenerator, com.sun.tools.xjc.model.Model, com.sun.tools.xjc.outline.Outline, com.sun.tools.xjc.reader.gbind.Expression, .Graph, com.sun.tools.xjc.reader.internalizer.DOMForest, com.sun.tools.xjc.reader.xmlschema.ExpressionBuilder, com.sun.tools.xjc.reader.xmlschema.parser.XMLSchemaInternalizationLogic, com.sun.tools.xjc.util.ErrorReceiverFilter, .NullStream, .Util, com.sun.tools.xjc.writer.SignatureWriter, com.sun.xml.xsom.XSComplexType, .XSParticle, .XSSchemaSet, org.xml.sax.SAXException, .SAXParseException

Command Line Interface of XJC.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static enum	Driver.Mode Operation mode.
pack-priv static class	Driver.OptionsEx Command-line arguments processor.
private static class	Driver.WeAreDone Used to signal that we've finished processing.

Field Summary

Modifier and Type	Field and Description
private static final String	SYSTEM_PROXY_PROPERTY

Constructor Summary

Access	Constructor and Description
private	Driver()

Method Summary

Modifier and Type	Method and Description
private static void	_main(String[] args)
public static String	getBuildID()
public static void	main(final String[] args)
public static int	Returns: If the compiler runs successfully, this method returns 0. All non-zero values indicate an error. The error message will be sent to the specified PrintStream. run(String[] specified command line parameters. If there is an error in the parameters, `BadCommandLineException` will be thrown. args, final PrintStream Status report of the compilation will be sent to this object. Useful to update users so that they will know something is happening. Only ignorable messages should be sent to this stream. This parameter can be null to suppress messages. status, final PrintStream Various non-ignorable output (error messages, etc) will go to this stream. out) Performs schema compilation and prints the status/error into the specified PrintStream.
public static int	Returns: If the compiler runs successfully, this method returns 0. All non-zero values indicate an error. The error message will be sent to the specified PrintStream. run(String[] specified command line parameters. If there is an error in the parameters, `BadCommandLineException` will be thrown. args, final XJCListener Receives messages from XJC reporting progress/errors. listener) Performs schema compilation and prints the status/error into the specified PrintStream.
private static void	setupProxies() Set useSystemProxies if needed
public static void	usage(Options If the parsing of options have started, set a partly populated `Options` object. opts, boolean privateUsage) Prints the usage screen and exits the process.

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

Field Detail

SYSTEM_PROXY_PROPERTY	back to summary
private static final String SYSTEM_PROXY_PROPERTY

Constructor Detail

Driver	back to summary
private Driver()

Method Detail

_main	back to summary
private static void _main(String[] args) throws Exception

getBuildID	back to summary
public static String getBuildID()

main	back to summary
public static void main(final String[] args) throws Exception

run back to summary

run	back to summary
public static int run(String[] args, final PrintStream status, final PrintStream out) throws Exception Performs schema compilation and prints the status/error into the specified PrintStream. This method could be used to trigger XJC from other tools, such as Ant or IDE. Parameters args:String[] specified command line parameters. If there is an error in the parameters, `BadCommandLineException` will be thrown. status:PrintStream Status report of the compilation will be sent to this object. Useful to update users so that they will know something is happening. Only ignorable messages should be sent to this stream. This parameter can be null to suppress messages. out:PrintStream Various non-ignorable output (error messages, etc) will go to this stream. Returns:int If the compiler runs successfully, this method returns 0. All non-zero values indicate an error. The error message will be sent to the specified PrintStream.

public static int run(String[] args, final PrintStream status, final PrintStream out) throws Exception

Performs schema compilation and prints the status/error into the specified PrintStream.

This method could be used to trigger XJC from other tools, such as Ant or IDE.

Parameters

args:String[]: specified command line parameters. If there is an error in the parameters, BadCommandLineException will be thrown.
status:PrintStream: Status report of the compilation will be sent to this object. Useful to update users so that they will know something is happening. Only ignorable messages should be sent to this stream. This parameter can be null to suppress messages.
out:PrintStream: Various non-ignorable output (error messages, etc) will go to this stream.

Returns:int

If the compiler runs successfully, this method returns 0. All non-zero values indicate an error. The error message will be sent to the specified PrintStream.

run back to summary

run	back to summary
public static int run(String[] args, final XJCListener listener) throws BadCommandLineException Performs schema compilation and prints the status/error into the specified PrintStream. This method could be used to trigger XJC from other tools, such as Ant or IDE. Parameters args:String[] specified command line parameters. If there is an error in the parameters, `BadCommandLineException` will be thrown. listener:XJCListener Receives messages from XJC reporting progress/errors. Returns:int If the compiler runs successfully, this method returns 0. All non-zero values indicate an error. The error message will be sent to the specified PrintStream.

public static int run(String[] args, final XJCListener listener) throws BadCommandLineException

Performs schema compilation and prints the status/error into the specified PrintStream.

This method could be used to trigger XJC from other tools, such as Ant or IDE.

Parameters

args:String[]: specified command line parameters. If there is an error in the parameters, BadCommandLineException will be thrown.
listener:XJCListener: Receives messages from XJC reporting progress/errors.

Returns:int

If the compiler runs successfully, this method returns 0. All non-zero values indicate an error. The error message will be sent to the specified PrintStream.

setupProxies	back to summary
private static void setupProxies() Set useSystemProxies if needed

usage back to summary

usage	back to summary
public static void usage(Options opts, boolean privateUsage) Prints the usage screen and exits the process. Parameters opts:Options If the parsing of options have started, set a partly populated `Options` object.

public static void usage(Options opts, boolean privateUsage)

Prints the usage screen and exits the process.

Parameters

opts:Options: If the parsing of options have started, set a partly populated Options object.

com.sun.tools.xjc back to summary

private final Enum Driver.Mode

Class Inheritance

extends Enum<Driver.Mode>

java.lang.Object
java.lang.Enum
com.sun.tools.xjc.Driver.Mode

Operation mode.

Field Summary

Modifier and Type	Field and Description
public static final Driver.Mode	CODE
public static final Driver.Mode	DRYRUN
public static final Driver.Mode	FOREST
public static final Driver.Mode	GBIND
public static final Driver.Mode	SIGNATURE
public static final Driver.Mode	ZIP

Constructor Summary

Access	Constructor and Description
private	Mode()

Method Summary

Modifier and Type	Method and Description
public static Driver.Mode	valueOf(String name)
public static Driver.Mode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CODE	back to summary
public static final Driver.Mode CODE

DRYRUN	back to summary
public static final Driver.Mode DRYRUN

FOREST	back to summary
public static final Driver.Mode FOREST

GBIND	back to summary
public static final Driver.Mode GBIND

SIGNATURE	back to summary
public static final Driver.Mode SIGNATURE

ZIP	back to summary
public static final Driver.Mode ZIP

Constructor Detail

Mode	back to summary
private Mode()

Method Detail

valueOf	back to summary
public static Driver.Mode valueOf(String name)

values	back to summary
public static Driver.Mode[] values()

com.sun.tools.xjc back to summary

pack-priv Class Driver.OptionsEx

Class Inheritance

extends Options

java.lang.Object
com.sun.tools.xjc.Options
com.sun.tools.xjc.Driver.OptionsEx

Command-line arguments processor.

This class contains options that only make sense for the command line interface.

Field Summary

Modifier and Type	Field and Description
protected Driver.Mode	mode Operation mode.
public boolean	noNS A switch that determines the behavior in the BGM mode.

Constructor Summary

Access	Constructor and Description
pack-priv	OptionsEx()

Method Summary

Modifier and Type	Method and Description
public int	parseArgument(String[] args, int i) Overrides com.sun.tools.xjc.Options.parseArgument. Parse XJC-specific options.

Field Detail

mode	back to summary
protected Driver.Mode mode Operation mode.

noNS	back to summary
public boolean noNS A switch that determines the behavior in the BGM mode.

Constructor Detail

OptionsEx	back to summary
pack-priv OptionsEx()

Method Detail

parseArgument	back to summary
public int parseArgument(String[] args, int i) throws BadCommandLineException Overrides com.sun.tools.xjc.Options.parseArgument. Parse XJC-specific options. Annotations @Override Exceptions BadCommandLineException: Doc from com.sun.tools.xjc.Options.parseArgument. If the callee wants to provide a custom message for an error.

parseArgument

back to summary

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

Overrides com.sun.tools.xjc.Options.parseArgument.

Parse XJC-specific options.

Annotations

@Override

Exceptions

BadCommandLineException:

Doc from com.sun.tools.xjc.Options.parseArgument.

If the callee wants to provide a custom message for an error.

com.sun.tools.xjc back to summary

private final Class Driver.WeAreDone

Class Inheritance

extends BadCommandLineException

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.sun.tools.xjc.BadCommandLineException
com.sun.tools.xjc.Driver.WeAreDone

Used to signal that we've finished processing.

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides com.sun.tools.xjc.BadCommandLineException.serialVersionUID.

Constructor Summary

Access	Constructor and Description
private	WeAreDone()

Method Summary

Inherited from com.sun.tools.xjc.BadCommandLineException:: getOptions initOptions

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.sun.tools.xjc.BadCommandLineException.serialVersionUID.

Constructor Detail

WeAreDone	back to summary
private WeAreDone()