Modifier and Type	Class and Description
private class	XJCBase.AntProgressCodeWriter `CodeWriter` that produces progress messages as Ant verbose messages.
private class	XJCBase.ErrorReceiverImpl `ErrorReceiver` that produces messages as Ant messages.

Field Summary

Modifier and Type	Field and Description
private String	addexports
private String	addmodules
private String	addopens
private String	addreads
private final ArrayList<File>	bindingFiles
private File	catalog
private final Path	classpath Used to load additional user-specified classes.
private final CommandlineJava	cmd
private final Commandline	cmdLine Additional command line arguments.
private final ArrayList<File>	dependsSet Files used to determine whether XJC should run or not.
private boolean	extension
private boolean	failonerror False to continue the build even if the compilation fails.
private boolean	fork
private String	limitmodules
private Path	modulepath
public final Options	options
private String	patchmodule
private final ArrayList<File>	producesSet
private boolean	producesSpecified Set to true once the `<produces>` element is used.
private boolean	removeOldOutput True if we will remove all the old output files before invoking XJC.
private final ArrayList<File>	schemaFiles
private String	specTarget
private long	stackSize User-specified stack size.
private Path	upgrademodulepath
private XMLCatalog	xmlCatalog for resolving entities such as dtds

Inherited from org.apache.tools.ant.taskdefs.MatchingTask:: fileset

Constructor Summary

Access	Constructor and Description
public	XJCBase()

Method Summary

Modifier and Type	Method and Description
private void	_doXJC()
public void	addConfiguredBinding(FileSet fs) Nested `<binding>` element.
public void	addConfiguredDepends(FileSet fs) Nested `<depends>` element.
public void	addConfiguredProduces(FileSet fs) Nested `<produces>` element.
public void	addConfiguredSchema(FileSet fs) Nested `<schema>` element.
public void	addConfiguredXMLCatalog(XMLCatalog the XMLCatalog instance to use to look up DTDs xmlCatalog) Add the catalog to our internal catalog
pack-priv void	addFilesToCommandLine(ArrayList<File> files, String option)
private void	addIndividualFilesTo(FileSet fs, List<File> lst) Extracts `File` objects that the given `FileSet` represents and adds them all to the given `List`.
private long	computeTimestampFor(List<File> files, boolean findNewest) Determines the timestamp of the newest/oldest file in the given set.
public Commandline.Argument	createArg()
public Path	createClasspath() Nested `<classpath>` element.
public Commandline.Argument	createJvmarg()
private void	doXJC()
public void	execute() Overrides org.apache.tools.ant.Task.execute. Runs XJC.
public String	getAddexports()
public String	getAddmodules()
public String	getAddopens()
public String	getAddreads()
public File	getCatalog()
pack-priv CommandlineJava	getCommandline()
public File	getDestdir()
public boolean	getDisableXmlSecurity()
public String	getEncoding()
public boolean	getExtension()
public boolean	Returns: true if execution should be done in forked JVM, false otherwise. getFork() Gets the "fork" flag.
public boolean	getHeader()
public boolean	getHeaderWithDate()
private InputSource	getInputSource(File f) Converts a File object to an InputSource.
private InputSource	getInputSource(URL url) Converts an URL to an InputSource.
public String	getLimitmodules()
public Path	getModulepath()
public String	getPackage()
public String	getPatchmodule()
public boolean	getReadOnly()
public boolean	getRemoveOldOutput()
public String	getSpecTarget()
public Path	getUpgrademodulepath()
public boolean	getVerbose()
private int	Returns: return value from the executed process. run(String[] arguments. command) Executes the given class name with the given arguments in a separate VM.
public void	setAddexports(String aes)
public void	setAddmodules(String ams)
public void	setAddopens(String aos)
public void	setAddreads(String ars)
public void	setBinding(String binding) External binding file.
public void	setCatalog(File catalog) Adds a new catalog file.
public void	setClasspath(Path cp) Nested `<classpath>` element.
public void	setClasspathRef(Reference r)
public void	setDestdir(File dir) Sets the directory to produce generated source files.
public void	setDisableXmlSecurity(boolean flg) Controls whether to disable XML security features when parsing XML documents or not
public void	setEncoding(String encoding)
public void	setExtension(boolean flg) Controls whether the compiler will run in the strict conformance mode (flg=false) or the extension mode (flg=true)
public void	setFailonerror(boolean value) Mostly for our SQE teams and not to be advertized.
public void	setFork(boolean true to run execution in a forked JVM. fork) Sets the "fork" flag.
public void	setHeader(boolean flg) Controls whether the file header comment is generated or not.
public void	setHeaderWithDate(boolean flg) Controls whether the file header comment should generate timestamp generation or not.
public void	setLanguage(String language) Sets the schema language.
public void	setLimitmodules(String lms)
public void	setModulepath(Path mp)
public void	setPackage(String pkg) Sets the package name of the generated code.
public void	setPatchmodule(String pms)
public void	setReadonly(boolean flg) Controls whether files should be generated in read-only mode or not
public void	setRemoveOldOutput(boolean roo) "removeOldOutput" attribute.
public void	setSchema(String A file name (can be relative to base dir), or an URL (must be absolute). schema) Parses the schema attribute.
public void	setStackSize(String ss) Deprecated not much need for JAXB2, as we now use much less stack. Sets the stack size of the XJC invocation.
public void	setTarget(String version) Sets the target version of the compilation
protected CommandlineJava	Returns: ready to run command line setupCommand() Set up command line to invoke.
pack-priv void	setupForkCommand(String className)
public void	setUpgrademodulepath(Path ump)
public void	setXexplicitAnnotation(boolean flg)
private InputSource[]	toInputSources(FileSet fs) Extracts files in the given `FileSet`.

Field Detail

addexports	back to summary
private String addexports

addmodules	back to summary
private String addmodules

addopens	back to summary
private String addopens

addreads	back to summary
private String addreads

bindingFiles	back to summary
private final ArrayList<File> bindingFiles

catalog	back to summary
private File catalog

classpath	back to summary
private final Path classpath Used to load additional user-specified classes.

cmd	back to summary
private final CommandlineJava cmd

cmdLine	back to summary
private final Commandline cmdLine Additional command line arguments.

dependsSet	back to summary
private final ArrayList<File> dependsSet Files used to determine whether XJC should run or not.

extension	back to summary
private boolean extension

failonerror	back to summary
private boolean failonerror False to continue the build even if the compilation fails.

fork	back to summary
private boolean fork

limitmodules	back to summary
private String limitmodules

modulepath	back to summary
private Path modulepath

options	back to summary
public final Options options

patchmodule	back to summary
private String patchmodule

producesSet	back to summary
private final ArrayList<File> producesSet

producesSpecified	back to summary
private boolean producesSpecified Set to true once the `<produces>` element is used. This flag is used to issue a suggestion to users.

removeOldOutput	back to summary
private boolean removeOldOutput True if we will remove all the old output files before invoking XJC.

schemaFiles	back to summary
private final ArrayList<File> schemaFiles

specTarget	back to summary
private String specTarget

stackSize	back to summary
private long stackSize User-specified stack size.

upgrademodulepath	back to summary
private Path upgrademodulepath

xmlCatalog	back to summary
private XMLCatalog xmlCatalog for resolving entities such as dtds

Constructor Detail

XJCBase	back to summary
public XJCBase()

Method Detail

_doXJC	back to summary
private void _doXJC() throws BuildException

addConfiguredBinding	back to summary
public void addConfiguredBinding(FileSet fs) Nested `<binding>` element.

addConfiguredDepends	back to summary
public void addConfiguredDepends(FileSet fs) Nested `<depends>` element.

addConfiguredProduces	back to summary
public void addConfiguredProduces(FileSet fs) Nested `<produces>` element.

addConfiguredSchema	back to summary
public void addConfiguredSchema(FileSet fs) Nested `<schema>` element.

addConfiguredXMLCatalog	back to summary
public void addConfiguredXMLCatalog(XMLCatalog xmlCatalog) Add the catalog to our internal catalog Parameters xmlCatalog:XMLCatalog the XMLCatalog instance to use to look up DTDs

addConfiguredXMLCatalog

back to summary

public void addConfiguredXMLCatalog(XMLCatalog xmlCatalog)

Add the catalog to our internal catalog

Parameters

xmlCatalog:XMLCatalog: the XMLCatalog instance to use to look up DTDs

addFilesToCommandLine	back to summary
pack-priv void addFilesToCommandLine(ArrayList<File> files, String option)

addIndividualFilesTo	back to summary
private void addIndividualFilesTo(FileSet fs, List<File> lst) Extracts `File` objects that the given `FileSet` represents and adds them all to the given `List`.

computeTimestampFor	back to summary
private long computeTimestampFor(List<File> files, boolean findNewest) Determines the timestamp of the newest/oldest file in the given set.

createArg	back to summary
public Commandline.Argument createArg()

createClasspath	back to summary
public Path createClasspath() Nested `<classpath>` element.

createJvmarg	back to summary
public Commandline.Argument createJvmarg()

doXJC	back to summary
private void doXJC() throws BuildException

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. Runs XJC. Annotations @Override Exceptions BuildException: Doc from org.apache.tools.ant.Task.execute. if something goes wrong with the build.

execute

back to summary

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

Runs XJC.

Annotations

@Override

Exceptions

BuildException:

Doc from org.apache.tools.ant.Task.execute.

if something goes wrong with the build.

getAddexports	back to summary
public String getAddexports()

getAddmodules	back to summary
public String getAddmodules()

getAddopens	back to summary
public String getAddopens()

getAddreads	back to summary
public String getAddreads()

getCatalog	back to summary
public File getCatalog()

getCommandline	back to summary
pack-priv CommandlineJava getCommandline()

getDestdir	back to summary
public File getDestdir()

getDisableXmlSecurity	back to summary
public boolean getDisableXmlSecurity()

getEncoding	back to summary
public String getEncoding()

getExtension	back to summary
public boolean getExtension()

getFork

back to summary

public boolean getFork()

Gets the "fork" flag.

Returns:boolean: true if execution should be done in forked JVM, false otherwise.

getHeader	back to summary
public boolean getHeader()

getHeaderWithDate	back to summary
public boolean getHeaderWithDate()

getInputSource	back to summary
private InputSource getInputSource(File f) Converts a File object to an InputSource.

getInputSource	back to summary
private InputSource getInputSource(URL url) Converts an URL to an InputSource.

getLimitmodules	back to summary
public String getLimitmodules()

getModulepath	back to summary
public Path getModulepath()

getPackage	back to summary
public String getPackage()

getPatchmodule	back to summary
public String getPatchmodule()

getReadOnly	back to summary
public boolean getReadOnly()

getRemoveOldOutput	back to summary
public boolean getRemoveOldOutput()

getSpecTarget	back to summary
public String getSpecTarget()

getUpgrademodulepath	back to summary
public Path getUpgrademodulepath()

getVerbose	back to summary
public boolean getVerbose()

run

back to summary

private int run(String[] command) throws BuildException

Executes the given class name with the given arguments in a separate VM.

Parameters

command:String[]: arguments.

Returns:int

return value from the executed process.

setAddexports	back to summary
public void setAddexports(String aes)

setAddmodules	back to summary
public void setAddmodules(String ams)

setAddopens	back to summary
public void setAddopens(String aos)

setAddreads	back to summary
public void setAddreads(String ars)

setBinding	back to summary
public void setBinding(String binding) External binding file.

setCatalog	back to summary
public void setCatalog(File catalog) Adds a new catalog file.

setClasspath	back to summary
public void setClasspath(Path cp) Nested `<classpath>` element.

setClasspathRef	back to summary
public void setClasspathRef(Reference r)

setDestdir	back to summary
public void setDestdir(File dir) Sets the directory to produce generated source files.

setDisableXmlSecurity	back to summary
public void setDisableXmlSecurity(boolean flg) Controls whether to disable XML security features when parsing XML documents or not

setEncoding	back to summary
public void setEncoding(String encoding)

setExtension	back to summary
public void setExtension(boolean flg) Controls whether the compiler will run in the strict conformance mode (flg=false) or the extension mode (flg=true)

setFailonerror	back to summary
public void setFailonerror(boolean value) Mostly for our SQE teams and not to be advertized.

setFork

back to summary

public void setFork(boolean fork)

Sets the "fork" flag.

Parameters

fork:boolean: true to run execution in a forked JVM.

setHeader	back to summary
public void setHeader(boolean flg) Controls whether the file header comment is generated or not.

setHeaderWithDate	back to summary
public void setHeaderWithDate(boolean flg) Controls whether the file header comment should generate timestamp generation or not.

setLanguage	back to summary
public void setLanguage(String language) Sets the schema language.

setLimitmodules	back to summary
public void setLimitmodules(String lms)

setModulepath	back to summary
public void setModulepath(Path mp)

setPackage	back to summary
public void setPackage(String pkg) Sets the package name of the generated code.

setPatchmodule	back to summary
public void setPatchmodule(String pms)

setReadonly	back to summary
public void setReadonly(boolean flg) Controls whether files should be generated in read-only mode or not

setRemoveOldOutput	back to summary
public void setRemoveOldOutput(boolean roo) "removeOldOutput" attribute.

setSchema

back to summary

public void setSchema(String schema)

Parses the schema attribute. This attribute will be used when there is only one schema.

Parameters

schema:String: A file name (can be relative to base dir), or an URL (must be absolute).

setStackSize

back to summary

public void setStackSize(String ss)

Deprecated

not much need for JAXB2, as we now use much less stack.

Sets the stack size of the XJC invocation.

Annotations

@Deprecated

setTarget	back to summary
public void setTarget(String version) Sets the target version of the compilation

setupCommand

back to summary

protected CommandlineJava setupCommand()

Set up command line to invoke.

Returns:CommandlineJava: ready to run command line

setupForkCommand	back to summary
pack-priv void setupForkCommand(String className)

setUpgrademodulepath	back to summary
public void setUpgrademodulepath(Path ump)

setXexplicitAnnotation	back to summary
public void setXexplicitAnnotation(boolean flg) See Also `Options#runtime14`

toInputSources	back to summary
private InputSource[] toInputSources(FileSet fs) Extracts files in the given `FileSet`.

com.sun.tools.xjc back to summary

private Class XJCBase.AntProgressCodeWriter

Class Inheritance

extends FilterCodeWriter

java.lang.Object
com.sun.codemodel.CodeWriter
com.sun.codemodel.writer.FilterCodeWriter
com.sun.tools.xjc.XJCBase.AntProgressCodeWriter

CodeWriter that produces progress messages as Ant verbose messages.

Field Summary

Inherited from com.sun.codemodel.writer.FilterCodeWriter:: core

Constructor Summary

Access	Constructor and Description
public	AntProgressCodeWriter(CodeWriter output)

Method Summary

Modifier and Type	Method and Description
public OutputStream	openBinary(JPackage pkg, String fileName) Overrides com.sun.codemodel.writer.FilterCodeWriter.openBinary. Called by CodeModel to store the specified file.

Inherited from com.sun.codemodel.writer.FilterCodeWriter:: close openSource

Constructor Detail

AntProgressCodeWriter	back to summary
public AntProgressCodeWriter(CodeWriter output)

Method Detail

openBinary

back to summary

public OutputStream openBinary(JPackage pkg, String fileName) throws IOException

Overrides com.sun.codemodel.writer.FilterCodeWriter.openBinary.

Doc from com.sun.codemodel.CodeWriter.openBinary.

Called by CodeModel to store the specified file. The callee must allocate a storage to store the specified file.

The returned stream will be closed before the next file is stored. So the callee can assume that only one OutputStream is active at any given time.

Annotations

@Override

com.sun.tools.xjc back to summary

private Class XJCBase.ErrorReceiverImpl

Class Inheritance

extends ErrorReceiver

java.lang.Object
com.sun.tools.xjc.ErrorReceiver
com.sun.tools.xjc.XJCBase.ErrorReceiverImpl

ErrorReceiver that produces messages as Ant messages.

Constructor Summary

Access	Constructor and Description
private	ErrorReceiverImpl()

Method Summary

Modifier and Type	Method and Description
public void	error(SAXParseException e) Implements abstract com.sun.tools.xjc.ErrorReceiver.error. Implements org.xml.sax.ErrorHandler.error, com.sun.tools.xjc.api.ErrorListener.error. Receive notification of a recoverable error.
public void	fatalError(SAXParseException e) Implements abstract com.sun.tools.xjc.ErrorReceiver.fatalError. Implements org.xml.sax.ErrorHandler.fatalError, com.sun.tools.xjc.api.ErrorListener.fatalError. Receive notification of a non-recoverable, fatal error.
public void	info(SAXParseException e) Implements abstract com.sun.tools.xjc.ErrorReceiver.info. Implements com.sun.tools.xjc.api.ErrorListener.info. Reports verbose messages to users.
private void	print(int logLevel, String header, SAXParseException e)
public void	warning(SAXParseException e) Implements abstract com.sun.tools.xjc.ErrorReceiver.warning. Implements org.xml.sax.ErrorHandler.warning, com.sun.tools.xjc.api.ErrorListener.warning. Receive notification of a warning.

Inherited from com.sun.tools.xjc.ErrorReceiver:: debug error error error error getLocationString pollAbort warning

Constructor Detail

ErrorReceiverImpl	back to summary
private ErrorReceiverImpl()

Method Detail

error

back to summary

public void error(SAXParseException e)

Implements abstract com.sun.tools.xjc.ErrorReceiver.error.

Implements org.xml.sax.ErrorHandler.error, com.sun.tools.xjc.api.ErrorListener.error.

Doc from org.xml.sax.ErrorHandler.error.

Receive notification of a recoverable error.

This corresponds to the definition of "error" in section 1.2 of the W3C XML 1.0 Recommendation. For example, a validating parser would use this callback to report the violation of a validity constraint. The default behaviour is to take no action.

The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end. If the application cannot do so, then the parser should report a fatal error even if the XML recommendation does not require it to do so.

Filters may use this method to report other, non-XML errors as well.

Annotations

@Override

fatalError

back to summary

public void fatalError(SAXParseException e)

Implements abstract com.sun.tools.xjc.ErrorReceiver.fatalError.

Implements org.xml.sax.ErrorHandler.fatalError, com.sun.tools.xjc.api.ErrorListener.fatalError.

Doc from org.xml.sax.ErrorHandler.fatalError.

Receive notification of a non-recoverable, fatal error.

As defined in section 1.2 of the W3C XML 1.0 Recommendation, fatal errors are those that would make it impossible for a parser to continue normal processing. These include violation of a well-formedness constraint, invalid encoding, and forbidden structural errors as described in the W3C XML 1.0 Recommendation.

Annotations

@Override

info

back to summary

public void info(SAXParseException e)

Implements abstract com.sun.tools.xjc.ErrorReceiver.info.

Implements com.sun.tools.xjc.api.ErrorListener.info.

Doc from com.sun.tools.xjc.ErrorReceiver.info.

Reports verbose messages to users. This method can be used to report additional non-essential messages. The implementation usually discards them unless some specific debug option is turned on.

Annotations

@Override

print	back to summary
private void print(int logLevel, String header, SAXParseException e)

warning

back to summary

public void warning(SAXParseException e)

Implements abstract com.sun.tools.xjc.ErrorReceiver.warning.

Implements org.xml.sax.ErrorHandler.warning, com.sun.tools.xjc.api.ErrorListener.warning.

Doc from org.xml.sax.ErrorHandler.warning.

Receive notification of a warning.

SAX parsers will use this method to report conditions that are not errors or fatal errors as defined by the XML recommendation. The default behaviour is to take no action.

The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end.

Filters may use this method to report other, non-XML warnings as well.

Annotations

@Override

public Class XJCBase

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class XJCBase.AntProgressCodeWriter

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class XJCBase.ErrorReceiverImpl

Constructor Summary

Method Summary

Constructor Detail

Method Detail