XmlFactoryHook Interface

com.bea.xml
XmlFactoryHook Interface

public interface XmlFactoryHook

A hook for the XML Bean Factory mechanism. Provided for advanced users who wish to provide their own implementation of the Factory.parse methods. This is used, for example, to defer reading XML streams until needed.

To use the hook, call XmlFactoryHook.ThreadContext.setHook(), passing your own XmlFactoryHook implementation. Then every call to a Factory method will be delgated to your hook. 

 MyHook hook = new MyHook();
 XmlFactoryHook.ThreadContext.setHook(hook);
 // this results in a call to hook.parse(...)
 XmlObject.Factory.parse(new File("test.xml"));
If the hook needs to turn around and invoke the built-in parsers, then it should do so by calling the appropriate method on the passed SchemaTypeLoader. Since SchemaTypeLoader.parse() methods delegate to the registered hook, a hook that wishes to actually invoke the default parser without having itself called back again should unregister itself before calling loader.parse(), and then re-register itself again after the call. 
 void parse(SchemaTypeLoader loader, ...)
 {
     XmlFactoryHook remember = XmlFactoryHook.ThreadContext.getHook();
     XmlFactoryHook.ThreadContext.setHook(null);
     loader.parse(...); // isn't hooked.
     XmlFactoryHook.ThreadContext.setHook(remember);
 }

Nested Class Summary
public static final classXmlFactoryHook.ThreadContext
           Used to manage the XmlFactoryHook for the current thread.

Method Summary
public XmlObject
newInstance(SchemaTypeLoader loader, SchemaType type, XmlOptions options)
Hooks Factory.newInstance calls
public XmlSaxHandler
newXmlSaxHandler(SchemaTypeLoader loader, SchemaType type, XmlOptions options)
Hooks Factory.newXmlSaxHandler calls
public XmlObject
parse(SchemaTypeLoader loader, String xmlText, SchemaType type, XmlOptions options)
Hooks Factory.parse calls
public XmlObject
parse(SchemaTypeLoader loader, InputStream jiois, SchemaType type, XmlOptions options)
Hooks Factory.parse calls
public XmlObject
parse(SchemaTypeLoader loader, Reader jior, SchemaType type, XmlOptions options)
Hooks Factory.parse calls
public XmlObject
parse(SchemaTypeLoader loader, Node node, SchemaType type, XmlOptions options)
Hooks Factory.parse calls
public XmlObject
parse(SchemaTypeLoader loader, XMLInputStream xis, SchemaType type, XmlOptions options)
Hooks Factory.parse calls

Method Detail

newInstance(SchemaTypeLoader, SchemaType, XmlOptions) Method

public XmlObject newInstance(SchemaTypeLoader loader, 
                             SchemaType type, 
                             XmlOptions options)
Hooks Factory.newInstance calls

newXmlSaxHandler(SchemaTypeLoader, SchemaType, XmlOptions) Method

public XmlSaxHandler newXmlSaxHandler(SchemaTypeLoader loader, 
                                      SchemaType type, 
                                      XmlOptions options)
Hooks Factory.newXmlSaxHandler calls

parse(SchemaTypeLoader, String, SchemaType, XmlOptions) Method

public XmlObject parse(SchemaTypeLoader loader, 
                       String xmlText, 
                       SchemaType type, 
                       XmlOptions options)
     throws XmlException
Hooks Factory.parse calls

Exceptions

XmlException

parse(SchemaTypeLoader, InputStream, SchemaType, XmlOptions) Method

public XmlObject parse(SchemaTypeLoader loader, 
                       InputStream jiois, 
                       SchemaType type, 
                       XmlOptions options)
     throws XmlException, IOException
Hooks Factory.parse calls

Exceptions

XmlException
IOException

parse(SchemaTypeLoader, Reader, SchemaType, XmlOptions) Method

public XmlObject parse(SchemaTypeLoader loader, 
                       Reader jior, 
                       SchemaType type, 
                       XmlOptions options)
     throws XmlException, IOException
Hooks Factory.parse calls

Exceptions

XmlException
IOException

parse(SchemaTypeLoader, Node, SchemaType, XmlOptions) Method

public XmlObject parse(SchemaTypeLoader loader, 
                       Node node, 
                       SchemaType type, 
                       XmlOptions options)
     throws XmlException
Hooks Factory.parse calls

Exceptions

XmlException

parse(SchemaTypeLoader, XMLInputStream, SchemaType, XmlOptions) Method

public XmlObject parse(SchemaTypeLoader loader, 
                       XMLInputStream xis, 
                       SchemaType type, 
                       XmlOptions options)
     throws XmlException, XMLStreamException
Hooks Factory.parse calls

Exceptions

XmlException
XMLStreamException