Package com.sun.tools.xjc.api.impl.s2j

Class SchemaCompilerImpl

java.lang.Object
com.sun.tools.xjc.ErrorReceiver
com.sun.tools.xjc.api.impl.s2j.SchemaCompilerImpl
All Implemented Interfaces:
ErrorListener, SchemaCompiler, com.sun.xml.bind.api.ErrorListener, ErrorHandler
public final class SchemaCompilerImpl extends ErrorReceiver implements SchemaCompiler
SchemaCompiler implementation. This class builds a DOMForest until the bind() method, then this method does the rest of the hard work.
Author:
Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
See Also:

  • Field Details

    • opts

      protected final Options opts

    • forest

      @NotNull protected DOMForest forest

  • Constructor Details

    • SchemaCompilerImpl

      public SchemaCompilerImpl()

  • Method Details

    • getOptions

      @NotNull public Options getOptions()
      Description copied from interface: SchemaCompiler
      Allows the calling code to tweak more schema compilation details.

      The caller can use this method to obtain an Options instance, then tweak settings on it. The updated settings will be used when the SchemaCompiler.bind() method is invoked.

      The returned Options object is useful for example to specify command-line arguments.

      Specified by:
      getOptions in interface SchemaCompiler

    • getParserHandler

      public ContentHandler getParserHandler(String systemId)
      Description copied from interface: SchemaCompiler
      Parses schemas or external bindings through SAX events by feeding events into SAX ContentHandler.
      Specified by:
      getParserHandler in interface SchemaCompiler
      Parameters:
      systemId - The system ID of the document to be read in.
      See Also:

    • parseSchema

      public void parseSchema(String systemId, Element element)
      Description copied from interface: SchemaCompiler
      Parses a schema or an external binding file from the specified DOM element.

      The given DOM element is treated as if it's the root of a virtual document.

      XJC will not be able to print location information for errors found in this document, since DOM doesn't have them. For this reason, use of this method is strongly discouraged.

      Specified by:
      parseSchema in interface SchemaCompiler
      Parameters:
      systemId - We need an absolute system ID that uniquely designates the virtual document. This should be different from the system ID of the document which contains this element.

      One way to do that is by adding a fragment identifier to the system ID of the document. For example, if the document is "foo.wsdl" and you are passing in its types section, you can use an unique identifier like "foo.wsdl#types"

    • parseSchema

      public void parseSchema(InputSource source)
      Description copied from interface: SchemaCompiler
      Parses a schema or an external binding file from an external source.
      Specified by:
      parseSchema in interface SchemaCompiler
      Parameters:
      source - Its system Id must be set to an absolute URI.

    • setTargetVersion

      public void setTargetVersion(SpecVersion version)
      Description copied from interface: SchemaCompiler
      Specifies the target spec version for this compilaion.
      Specified by:
      setTargetVersion in interface SchemaCompiler
      Parameters:
      version - If null, XJC will generate the source code that takes advantage of the latest JAXB spec that it understands.

    • parseSchema

      public void parseSchema(String systemId, XMLStreamReader reader) throws XMLStreamException
      Description copied from interface: SchemaCompiler
      Parses a schema or an external binding file from the given source.

      A stream reader must be pointing at the element or at the start of the document. XML is parsed until the corresponding end tag, then the sub tree is processed as a schema document.

      When this method returns successfully, the parser is at the next token of the end element.

      Specified by:
      parseSchema in interface SchemaCompiler
      Parameters:
      systemId - The absolute system ID of the document that is being parsed. This information is necessary to avoid double-inclusion and etc. Note that XMLStreamReader.getLocation() only returns the system ID of the entity it is parsing, not necessarily the system ID of the document itself.
      Throws:
      XMLStreamException - If an error happens while parsing a document. Note that not only the parser but also the XJC itself may throw this error (as a result of the additional validation for example.)

    • setEntityResolver

      public void setEntityResolver(EntityResolver entityResolver)
      Specified by:
      setEntityResolver in interface SchemaCompiler

    • setDefaultPackageName

      public void setDefaultPackageName(String packageName)
      Description copied from interface: SchemaCompiler
      Sets the default Java package name into which the generated code will be placed.

      Customizations in the binding files/schemas will have precedence over this setting. Set to null to use the default package name computation algorithm as specified by the JAXB spec (which is the default behavior.)

      Initially this parameter is set to null.

      Specified by:
      setDefaultPackageName in interface SchemaCompiler
      Parameters:
      packageName - Java pckage name such as "org.foo.bar". Use "" to represent the root package, and null to defer to the default computation algorithm.
      See Also:

    • forcePackageName

      public void forcePackageName(String packageName)
      Description copied from interface: SchemaCompiler
      Forces all the JAXB-generated classes to go into the specific package.

      This setting takes precedence over the SchemaCompiler.setDefaultPackageName(String) or any of the customization found in the JAXB binding files. This method is designed to implement the semantics of the command-line '-p' option.

      This somewhat ugly semantics actually have a long history now and too late to change.

      Specified by:
      forcePackageName in interface SchemaCompiler
      See Also:

    • setClassNameAllocator

      public void setClassNameAllocator(ClassNameAllocator allocator)
      Description copied from interface: SchemaCompiler
      Sets the ClassNameAllocator to be used for the binding operation.

      This mechanism would allow the caller to participate in the binding operation.

      Specified by:
      setClassNameAllocator in interface SchemaCompiler
      See Also:

    • resetSchema

      public void resetSchema()
      Description copied from interface: SchemaCompiler
      Clears all the schema files parsed so far.
      Specified by:
      resetSchema in interface SchemaCompiler

    • bind

      public com.sun.tools.xjc.api.impl.s2j.JAXBModelImpl bind()
      Description copied from interface: SchemaCompiler
      Obtains the compiled schema object model. Once this method is called, no other method should be invoked on the SchemaCompiler.
      Specified by:
      bind in interface SchemaCompiler
      Returns:
      null if the compilation fails. The errors should have been delivered to the registered error handler in such a case.

    • setErrorListener

      public void setErrorListener(ErrorListener errorListener)
      Specified by:
      setErrorListener in interface SchemaCompiler

    • info

      public void info(SAXParseException exception)
      Description copied from class: ErrorReceiver
      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.
      Specified by:
      info in interface ErrorListener
      Specified by:
      info in interface com.sun.xml.bind.api.ErrorListener
      Specified by:
      info in class ErrorReceiver

    • warning

      public void warning(SAXParseException exception)
      Specified by:
      warning in interface ErrorHandler
      Specified by:
      warning in interface ErrorListener
      Specified by:
      warning in interface com.sun.xml.bind.api.ErrorListener
      Specified by:
      warning in class ErrorReceiver

    • error

      public void error(SAXParseException exception)
      Specified by:
      error in interface ErrorHandler
      Specified by:
      error in interface ErrorListener
      Specified by:
      error in interface com.sun.xml.bind.api.ErrorListener
      Specified by:
      error in class ErrorReceiver

    • fatalError

      public void fatalError(SAXParseException exception)
      Specified by:
      fatalError in interface ErrorHandler
      Specified by:
      fatalError in interface ErrorListener
      Specified by:
      fatalError in interface com.sun.xml.bind.api.ErrorListener
      Specified by:
      fatalError in class ErrorReceiver