v2/src/xmlpublic/org/apache/xmlbeans/BindingContextFactory.java

/*   Copyright 2004 The Apache Software Foundation
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package org.apache.xmlbeans;


import java.io.IOException;
import java.net.URI;
import java.net.URL;
import java.util.jar.JarInputStream;

/**
 * BindingContextFactory is used to create BindingContext objects
 * from a binding configuration file.
 */
public abstract class BindingContextFactory
{
  /**
   * Create a BindingContext that only knows about builtin types
   *
   * @return a BindingContext object for builtin types
   */
  public abstract BindingContext createBindingContext();

  /**
   * Creates a BindingContext which loads tylar resources out of the
   * given ClassLoader.
   *
   * @param cl the classloader on which the tylar(s) can be loaded.
   * @throws IOException if a problem occurs while opening or parsing the
   * contents of the tylars.
   */
  public abstract BindingContext createBindingContext(ClassLoader cl)
          throws IOException, XmlException;


  protected final static String DEFAULT_IMPL =
          "org.apache.xmlbeans.impl.marshal.BindingContextFactoryImpl";

  public static BindingContextFactory newInstance()
  {
    try {
      Class default_impl = Class.forName(DEFAULT_IMPL);
      final BindingContextFactory factory =
              (BindingContextFactory)default_impl.newInstance();
      return factory;
    }
    catch (ClassNotFoundException e) {
      throw new XmlRuntimeException(e);
    }
    catch (InstantiationException e) {
      throw new XmlRuntimeException(e);
    }
    catch (IllegalAccessException e) {
      throw new XmlRuntimeException(e);
    }
  }


  // ========================================================================
  // deprecated methods

  /**
   * @deprecated
   */
  public abstract BindingContext createBindingContext(URI tylarUri)
      throws IOException, XmlException;

  /**
   * @deprecated
   */
  public abstract BindingContext createBindingContext(URI[] tylarUris)
      throws IOException, XmlException;

  /**
   * @deprecated
   */
  public abstract BindingContext createBindingContext(JarInputStream jar)
      throws IOException, XmlException;

}