v2/src/binding/org/apache/xmlbeans/impl/binding/compile/TylarBuilder.java

/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 2003 The Apache Software Foundation.  All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in
*    the documentation and/or other materials provided with the
*    distribution.
*
* 3. The end-user documentation included with the redistribution,
*    if any, must include the following acknowledgment:
*       "This product includes software developed by the
*        Apache Software Foundation (http://www.apache.org/)."
*    Alternately, this acknowledgment may appear in the software itself,
*    if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" must
*    not be used to endorse or promote products derived from this
*    software without prior written permission. For written
*    permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache
*    XMLBeans", nor may "Apache" appear in their name, without prior
*    written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 2003 BEA Systems
* Inc., <http://www.bea.com/>. For more information on the Apache Software
* Foundation, please see <http://www.apache.org/>.
*/
package org.apache.xmlbeans.impl.binding.compile;

import org.w3.x2001.xmlSchema.SchemaDocument;
import org.apache.xmlbeans.impl.binding.bts.BindingFile;

import java.io.IOException;

/**
 * Isolates binding compilation tasks from details of how their outputs are
 * actually written out to disk.  There will probably be at least two
 * implementations of this interface: one that outputs a jarred 'tylar' and
 * another which outputs a directory.
 *
 * We may want to change the name of this class; I'm still a little uneasy
 * about 'tylar,' but for the moment, at least everyone will understand what
 * this is.
 *
 * @author Patrick Calahan <pcal@bea.com>
 */
public interface TylarBuilder {

/**
 * Adds the given schema document to the type library.
 */
  public void addSchema(SchemaDocument sd);

  /**
   * Adds the given binding config to the type library.
   */
  public void addBindingFile(BindingFile bf);

  /**
   * This should be called to inform the builder that work is complete and
   * that it should write all of its output to disk (or whatever it wants
   * to do).  This method can be called at most once for a given instance
   * of TylarBuilder; any subsequent method calls on that instance will result
   * in an IllegalStateException.
   *
   * @throws IOException if an error occurs while performing output. REVIEW
   */
  public void complete() throws IOException;

}