Save This Page
Home » xmlbeans-2.4.0-src » org.apache.xmlbeans.impl.tool » [javadoc | source]
org.apache.xmlbeans.impl.tool
public class: XMLBean [javadoc | source]
java.lang.Object
   org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
         org.apache.tools.ant.taskdefs.MatchingTask
            org.apache.xmlbeans.impl.tool.XMLBean

All Implemented Interfaces:
    SelectorContainer, Cloneable

Modeled after Ant's javac and zip tasks. Schema files to process, or directories of schema files, are set with the 'schema' attribute, and can be filtered with 'includes' and 'excludes'. Alternatively, one or more nested <fileset> elements can specify the files and directories to be used to generate this XMLBean. The include set can also define .java files that should be built as well. See the FileSet documentation at http://jakarta.apache.org/ant/manual/index.html for instructions on FileSets if you are unfamiliar with their usage.
Nested Class Summary:
public class  XMLBean.ErrorLogger   
Method from org.apache.xmlbeans.impl.tool.XMLBean Summary:
addFileset,   createClasspath,   createExtension,   execute,   getCatalog,   getClassgendir,   getClasspath,   getDebugLevel,   getDestfile,   getExecutable,   getIgnoreDuplicatesInNamespaces,   getJavaSource,   getMemoryInitialSize,   getMemoryMaximumSize,   getOptimize,   getSchema,   getSrcgendir,   getTypesystemname,   isDebug,   isDownload,   isFailonerror,   isIncludeAntRuntime,   isIncludeJavaRuntime,   isNoAnnotations,   isNoExt,   isNoPvr,   isNoSrcRegen,   isNoUpa,   isNoValidateDoc,   isQuiet,   isSrconly,   isVerbose,   setCatalog,   setClassgendir,   setClasspath,   setClasspathRef,   setCompiler,   setDebug,   setDebugLevel,   setDestfile,   setDownload,   setExecutable,   setFailonerror,   setFork,   setIgnoreDuplicatesInNamespaces,   setIncludeAntRuntime,   setIncludeJavaRuntime,   setJavaSource,   setMemoryInitialSize,   setMemoryMaximumSize,   setNoAnnotations,   setNoExt,   setNoPvr,   setNoSrcRegen,   setNoUpa,   setNoValidateDoc,   setOptimize,   setQuiet,   setSchema,   setSource,   setSrcgendir,   setSrconly,   setTypesystemname,   setVerbose
Methods from org.apache.tools.ant.taskdefs.MatchingTask:
XsetIgnore,   XsetItems,   add,   addAnd,   addContains,   addContainsRegexp,   addCustom,   addDate,   addDepend,   addDepth,   addDifferent,   addFilename,   addMajority,   addModified,   addNone,   addNot,   addOr,   addPresent,   addSelector,   addSize,   addType,   appendSelector,   createExclude,   createExcludesFile,   createInclude,   createIncludesFile,   createPatternSet,   getSelectors,   hasSelectors,   selectorCount,   selectorElements,   setCaseSensitive,   setDefaultexcludes,   setExcludes,   setExcludesfile,   setFollowSymlinks,   setIncludes,   setIncludesfile,   setProject
Methods from org.apache.tools.ant.Task:
bindToOwner,   execute,   getOwningTarget,   getRuntimeConfigurableWrapper,   getTaskName,   getTaskType,   init,   log,   log,   log,   log,   maybeConfigure,   perform,   reconfigure,   setOwningTarget,   setRuntimeConfigurableWrapper,   setTaskName,   setTaskType
Methods from org.apache.tools.ant.ProjectComponent:
clone,   getDescription,   getLocation,   getProject,   log,   log,   setDescription,   setLocation,   setProject
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.xmlbeans.impl.tool.XMLBean Detail:
 public  void addFileset(FileSet fileset) 
 public Path createClasspath() 
    Adds a path to the classpath.
 public Extension createExtension() 
    One or more SchemaCompiler extensions can be passed in via the <extension> subelement. Schema Compiler extensions must implement the interface com.xbean.too.SchemaCompilerExtension
 public  void execute() throws BuildException 
 public String getCatalog() 
    Gets the XML Catalog file for org.apache.xml.resolver.tools.CatalogResolver. (Note: needs resolver.jar from http://xml.apache.org/commons/components/resolver/index.html)
 public File getClassgendir() 
 public Path getClasspath() 
 public String getDebugLevel() 
    Get the value of debugLevel.
 public File getDestfile() 
 public String getExecutable() 
 public String getIgnoreDuplicatesInNamespaces() 
 public String getJavaSource() 
 public String getMemoryInitialSize() 
    Set the initial memory size of the underlying javac process.
 public String getMemoryMaximumSize() 
    Set the maximum memory size of the underlying javac process.
 public boolean getOptimize() 
    Gets the optimize flag.
 public File getSchema() 
 public File getSrcgendir() 
 public String getTypesystemname() 
 public boolean isDebug() 
 public boolean isDownload() 
 public boolean isFailonerror() 
 public boolean isIncludeAntRuntime() 
 public boolean isIncludeJavaRuntime() 
 public boolean isNoAnnotations() 
 public boolean isNoExt() 
 public boolean isNoPvr() 
 public boolean isNoSrcRegen() 
 public boolean isNoUpa() 
 public boolean isNoValidateDoc() 
 public boolean isQuiet() 
 public boolean isSrconly() 
 public boolean isVerbose() 
 public  void setCatalog(String catalog) 
    Sets the XML Catalog file for org.apache.xml.resolver.tools.CatalogResolver. (Note: needs resolver.jar from http://xml.apache.org/commons/components/resolver/index.html)
 public  void setClassgendir(File classgendir) 
    Set a location to generate .class files into. Optional, defaults to a temp dir.
 public  void setClasspath(Path classpath) 
    The classpath to use if schemas in the fileset import definitions that are supplied by other compiled xml beans JAR files, or if .java files are in the schema fileset.
 public  void setClasspathRef(Reference classpathref) 
    Adds a reference to a classpath defined elsewhere.
 public  void setCompiler(String compiler) 
    Choose the implementation for this particular task.
 public  void setDebug(boolean debug) 
    Generate debugging symbols.
 public  void setDebugLevel(String v) 
    Keyword list to be appended to the -g command-line switch. This will be ignored by all implementations except modern and classic(ver >= 1.2). Legal values are none or a comma-separated list of the following keywords: lines, vars, and source. If debuglevel is not specified, by default, :none will be appended to -g. If debug is not turned on, this attribute will be ignored.
 public  void setDestfile(File destfile) 
    Define the name of the jar file created. For instance, "myXMLBean.jar" will output the results of this task into a jar with the same name. Optional, defaults to "xmltypes.jar".
 public  void setDownload(boolean download) 
    Set to true to permit the compiler to download URLs for imports and includes. Defaults to false, meaning all imports and includes must be copied locally.
 public  void setExecutable(String forkExec) 
    Sets the the name of the javac executable.

    Ignored unless fork is true or extJavac has been specified as the compiler.

 public  void setFailonerror(boolean failonerror) 
    Determines whether or not the ant target will continue if the XMLBean creation encounters a build error. Defaults to true. Optional.
 public  void setFork(boolean f) 
    If true, forks the javac compiler.
 public  void setIgnoreDuplicatesInNamespaces(String namespaces) 
    One or more namespaces in which duplicate definitions are to be ignored can be passed in via the <ignoreDuplicatesInNamespaces> subelement.
 public  void setIncludeAntRuntime(boolean includeAntRuntime) 
 public  void setIncludeJavaRuntime(boolean includeJavaRuntime) 
 public  void setJavaSource(String javasource) 
    Generate java source compatible with the given version. Currently, only "1.4" or "1.5" are supported and "1.4" is the default.
 public  void setMemoryInitialSize(String memoryInitialSize) 
 public  void setMemoryMaximumSize(String memoryMaximumSize) 
 public  void setNoAnnotations(boolean noann) 
    Skip over schema <annotation%gt; elements.
 public  void setNoExt(boolean noext) 
    Ignore extensions found in .xsdconfig files
 public  void setNoPvr(boolean nopvr) 
    Do not enforce the particle valid (restriction) rule.
 public  void setNoSrcRegen(boolean noSrcRegen) 
 public  void setNoUpa(boolean noupa) 
    Do not enforce the unique particle attribution rule.
 public  void setNoValidateDoc(boolean novdoc) 
    Do not validate the contents of schema <documentation> elements.
 public  void setOptimize(boolean optimize) 
    If true, compiles with optimization enabled.
 public  void setQuiet(boolean quiet) 
    Controls the amount of output. Defaults to false.
 public  void setSchema(File schema) 
    A file that points to either an individual schema file or a directory of files. It is optional only if one or more <fileset> elements are nested in this task.
 public  void setSource(String s) 
 public  void setSrcgendir(File srcgendir) 
    Set a location to generate .java files into. Optional, defaults to a temp dir.
 public  void setSrconly(boolean srconly) 
    A value of true means that only source will be generated. Optional, default is false.
 public  void setTypesystemname(String typesystemname) 
    The name of the package that the TypeSystemHolder class should be generated in. Normally this should be left unspecified. None of the xml beans are generated in this package.

    Use .xsdconfig files to modify xml bean package or class names.
 public  void setVerbose(boolean verbose) 
    Controls the amount of output. Defaults to true.