org.apache.excalibur.xmlizer.XMLizer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of excalibur-xmlutil Show documentation

Excalibur's XML Utilities provide simplified wrappers for XML parsers, transformers and XPath evaluators. It also provides interfaces and classes useful for constructing a pipeline of XML components by defining interfaces for consuming and producing XML in either SAX or DOM formats.

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.excalibur.xmlizer;

import java.io.IOException;
import java.io.InputStream;

import org.xml.sax.ContentHandler;
import org.xml.sax.SAXException;

/**
 * Converter for transforming any input stream with a given mime-type
 * into SAX events.
 *
 * @author Avalon Development Team
 * @version CVS $Revision: 1.4 $ $Date: 2004/02/28 11:47:34 $
 */
public interface XMLizer
{
    String ROLE = XMLizer.class.getName();

    /**
     * Generates SAX events from the given input stream
     * NOTE : if the implementation can produce lexical events, care should be taken
     * that handler can actually be a
     * {@link org.apache.excalibur.xml.sax.XMLConsumer} that accepts such
     * events or directly implements the LexicalHandler interface!
     * @param stream    the data
     * @param mimeType  the mime-type for the data
     * @param systemID  the URI defining the data (this is optional and can be null)
     */
    void toSAX( InputStream stream,
                String mimeType,
                String systemID,
                ContentHandler handler )
        throws SAXException, IOException;
}