v2/src/binding/org/apache/xmlbeans/impl/binding/tylar/ExplodedTylar.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.impl.binding.tylar;

import java.io.File;
import java.io.IOException;

/**
 * An extension of Tylar which is known to exist as an open directory
 * structure.  This is useful for consumers who may need additional control
 * over the generated artifacts, e.g. to manually perform compilation of
 * generated java source files.
 *
 * @author Patrick Calahan <pcal@bea.com>
 */
public interface ExplodedTylar extends Tylar {

  // ========================================================================
  // Public methods - these services are the 'value add' we provide over
  // just a generic Tylar.

  /**
   * Returns the directory on disk in which the tylar is stored.  Never
   * returns null.
   */
  public File getRootDir();

  /**
   * Returns the directory in which generated source files are stored in
   * the tylar.
   */
  public File getSourceDir();

  /**
   * Returns the directory in which generated class files are stored in
   * the tylar.  (Note that this typically is the same as the root dir).
   */
  public File getClassDir();

  /**
   * Returns the directory in which generated schema files are stored in
   * the tylar.
   */
  public File getSchemaDir();


  /**
   * Jars up the exploded tylar directory into the given file and returns
   * a handle to the TylarImpl.  The main advantage of using this method
   * as opposed to jarring it yourself is that you will save you the cost of
   * reparsing the binding file and the schemas in the event that you want to
   * immediately hand the tylar to the runtime.
   *
   * @param jarfile Destination file for the new jar
   * @return A handle to the newly-created tylar
   * @throws java.io.IOException if the specified jarfile already exists or if
   * an error occurs while writing the file.
   */
  public Tylar toJar(File jarfile) throws IOException;
}