XMLizer


1   /* 
2    * Copyright 2002-2004 The Apache Software Foundation
3    * Licensed  under the  Apache License,  Version 2.0  (the "License");
4    * you may not use  this file  except in  compliance with the License.
5    * You may obtain a copy of the License at 
6    * 
7    *   http://www.apache.org/licenses/LICENSE-2.0
8    * 
9    * Unless required by applicable law or agreed to in writing, software
10   * distributed  under the  License is distributed on an "AS IS" BASIS,
11   * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
12   * implied.
13   * 
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.excalibur.xmlizer;
18  
19  import java.io.IOException  ;
20  import java.io.InputStream  ;
21  
22  import org.xml.sax.ContentHandler  ;
23  import org.xml.sax.SAXException  ;
24  
25  /**
26   * Converter for transforming any input stream with a given mime-type
27   * into SAX events.
28   *
29   * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
30   * @version CVS $Revision: 1.4 $ $Date: 2004/02/28 11:47:34 $
31   */
32  public interface XMLizer
33  {
34      String   ROLE = XMLizer.class.getName();
35  
36      /**
37       * Generates SAX events from the given input stream
38       * <b>NOTE</b> : if the implementation can produce lexical events, care should be taken
39       * that <code>handler</code> can actually be a
40       * {@link org.apache.excalibur.xml.sax.XMLConsumer} that accepts such
41       * events or directly implements the LexicalHandler interface!
42       * @param stream    the data
43       * @param mimeType  the mime-type for the data
44       * @param systemID  the URI defining the data (this is optional and can be null)
45       */
46      void toSAX( InputStream   stream,
47                  String   mimeType,
48                  String   systemID,
49                  ContentHandler   handler )
50          throws SAXException  , IOException  ;
51  }
52  
53
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags