1   /**
2    * Distribution License:
3    * JSword is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU Lesser General Public License, version 2.1 as published by
5    * the Free Software Foundation. This program is distributed in the hope
6    * that it will be useful, but WITHOUT ANY WARRANTY; without even the
7    * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8    * See the GNU Lesser General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *       http://www.gnu.org/copyleft/lgpl.html
12   * or by writing to:
13   *      Free Software Foundation, Inc.
14   *      59 Temple Place - Suite 330
15   *      Boston, MA 02111-1307, USA
16   *
17   * Copyright: 2005
18   *     The copyright to this program is held by it's authors.
19   *
20   * ID: $Id: Converter.java 1966 2009-10-30 01:15:14Z dmsmith $
21   */
22  package org.crosswire.common.xml;
23  
24  import javax.xml.transform.TransformerException;
25  
26  /**
27   * A generic method of converting one SAX stream into another. This can be a
28   * wrapper around an XSL transform or anything else.
29   * 
30   * @see gnu.lgpl.License for license details.<br>
31   *      The copyright to this program is held by it's authors.
32   * @author Joe Walker [joe at eireneh dot com]
33   */
34  public interface Converter {
35      /**
36       * Convert one SAX stream into another.
37       * 
38       * @param provider
39       *            The source stream
40       * @return The destination stream
41       * @throws TransformerException
42       *             If the transformation can't be completed
43       */
44      SAXEventProvider convert(SAXEventProvider provider) throws TransformerException;
45  }
46