com.sun.org.apache.xml.internal.dtm.ref.IncrementalSAXSource Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.servicemix.bundles.jaxp-ri
Show all versions of org.apache.servicemix.bundles.jaxp-ri
This OSGi bundle wraps ${pkgArtifactId} ${pkgVersion} jar file.
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* 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.
*/
/*
* $Id: IncrementalSAXSource.java,v 1.8 2010-11-01 04:34:38 joehw Exp $
*/
package com.sun.org.apache.xml.internal.dtm.ref;
import org.xml.sax.ContentHandler;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
/** IncrementalSAXSource is an API that delivers a small number of
* SAX events each time a request is made from a "controller"
* coroutine. See IncrementalSAXFilter and IncrementalSAXFilter_Xerces
* for examples.
*
* Note that interaction is via the deliverMoreNodes
* method, and therefore coroutine support is not exposed
* here.
* */
public interface IncrementalSAXSource
{
// ------------------------------------------------------------------
// SAX Output API
// ------------------------------------------------------------------
/** Register a SAX-style content handler for us to output to
*/
public void setContentHandler(ContentHandler handler);
/** Register a SAX-style lexical handler for us to output to
*/
public void setLexicalHandler(org.xml.sax.ext.LexicalHandler handler);
/** Register a SAX-style DTD handler for us to output to
*/
public void setDTDHandler(org.xml.sax.DTDHandler handler);
// ------------------------------------------------------------------
// Command Input API
// ------------------------------------------------------------------
/** deliverMoreNodes() is a simple API which tells the thread in which the
* IncrementalSAXSource is running to deliver more events (true),
* or stop delivering events and close out its input (false).
*
* This is intended to be called from one of our partner coroutines,
* and serves to encapsulate the coroutine communication protocol.
*
* @param parsemore If true, tells the incremental SAX stream to deliver
* another chunk of events. If false, finishes out the stream.
*
* @return Boolean.TRUE if the IncrementalSAXSource believes more data
* may be available for further parsing. Boolean.FALSE if parsing
* ran to completion, or was ended by deliverMoreNodes(false).
* */
public Object deliverMoreNodes (boolean parsemore);
// ------------------------------------------------------------------
// Parse Thread Convenience API
// ------------------------------------------------------------------
/** Launch an XMLReader's parsing operation, feeding events to this
* IncrementalSAXSource. In some implementations, this may launch a
* thread which runs the previously supplied XMLReader's parse() operation.
* In others, it may do other forms of initialization.
*
* @throws SAXException is parse thread is already in progress
* or parsing can not be started.
* */
public void startParse(InputSource source) throws SAXException;
} // class IncrementalSAXSource