com.sun.org.apache.xml.internal.serializer.WriterChain 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: WriterChain.java,v 1.7 2010-11-01 04:34:45 joehw Exp $
*/
package com.sun.org.apache.xml.internal.serializer;
import java.io.IOException;
/**
* It is unfortunate that java.io.Writer is a class rather than an interface.
* The serializer has a number of classes that extend java.io.Writer
* and which send their ouput to a yet another wrapped Writer or OutputStream.
*
* The purpose of this interface is to force such classes to over-ride all of
* the important methods defined on the java.io.Writer class, namely these:
*
* write(int val)
* write(char[] chars)
* write(char[] chars, int start, int count)
* write(String chars)
* write(String chars, int start, int count)
* flush()
* close()
*
* In this manner nothing will accidentally go directly to
* the base class rather than to the wrapped Writer or OutputStream.
*
* The purpose of this class is to have a uniform way of chaining the output of one writer to
* the next writer in the chain. In addition there are methods to obtain the Writer or
* OutputStream that this object sends its output to.
*
* This interface is only for internal use withing the serializer.
* @xsl.usage internal
*/
interface WriterChain
{
/** This method forces us to over-ride the method defined in java.io.Writer */
public void write(int val) throws IOException;
/** This method forces us to over-ride the method defined in java.io.Writer */
public void write(char[] chars) throws IOException;
/** This method forces us to over-ride the method defined in java.io.Writer */
public void write(char[] chars, int start, int count) throws IOException;
/** This method forces us to over-ride the method defined in java.io.Writer */
public void write(String chars) throws IOException;
/** This method forces us to over-ride the method defined in java.io.Writer */
public void write(String chars, int start, int count) throws IOException;
/** This method forces us to over-ride the method defined in java.io.Writer */
public void flush() throws IOException;
/** This method forces us to over-ride the method defined in java.io.Writer */
public void close() throws IOException;
/**
* If this method returns null, getOutputStream() must return non-null.
* Get the writer that this writer sends its output to.
*
* It is possible that the Writer returned by this method does not
* implement the WriterChain interface.
*/
public java.io.Writer getWriter();
/**
* If this method returns null, getWriter() must return non-null.
* Get the OutputStream that this writer sends its output to.
*/
public java.io.OutputStream getOutputStream();
}