aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.bind.v2.runtime.output;
aoqi@0: 
aoqi@0: import java.io.IOException;
aoqi@0: import java.io.OutputStream;
aoqi@0: 
aoqi@0: import javax.xml.stream.XMLStreamException;
aoqi@0: 
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.Name;
aoqi@0: import com.sun.xml.internal.bind.v2.runtime.XMLSerializer;
aoqi@0: 
aoqi@0: import org.xml.sax.SAXException;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Abstract implementation of {@link XmlOutput}
aoqi@0:  *
aoqi@0:  * Implements the optimal methods, where defer to
aoqi@0:  * the non-optimal methods.
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  */
aoqi@0: public abstract class XmlOutputAbstractImpl implements XmlOutput {
aoqi@0: //
aoqi@0: //
aoqi@0: // Contracts
aoqi@0: //
aoqi@0: //
aoqi@0:     /**
aoqi@0:      * Called at the very beginning.
aoqi@0:      *
aoqi@0:      * @param serializer
aoqi@0:      *      the {@link XMLSerializer} that coordinates this whole marshalling episode.
aoqi@0:      * @param fragment
aoqi@0:      *      true if we are marshalling a fragment.
aoqi@0:      */
aoqi@0:     public void startDocument(XMLSerializer serializer, boolean fragment, int[] nsUriIndex2prefixIndex, NamespaceContextImpl nsContext) throws IOException, SAXException, XMLStreamException {
aoqi@0:         this.nsUriIndex2prefixIndex = nsUriIndex2prefixIndex;
aoqi@0:         this.nsContext = nsContext;
aoqi@0:         this.serializer = serializer;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Called at the very end.
aoqi@0:      *
aoqi@0:      * @param fragment
aoqi@0:      *      false if we are writing the whole document.
aoqi@0:      */
aoqi@0:     public void endDocument(boolean fragment) throws IOException, SAXException, XMLStreamException {
aoqi@0:         serializer = null;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Writes a start tag.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * At this point {@link #nsContext} holds namespace declarations needed for this
aoqi@0:      * new element.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * This method is used for writing tags that are indexed.
aoqi@0:      */
aoqi@0:     public void beginStartTag(Name name) throws IOException, XMLStreamException {
aoqi@0:         beginStartTag( nsUriIndex2prefixIndex[name.nsUriIndex], name.localName );
aoqi@0:     }
aoqi@0: 
aoqi@0:     public abstract void beginStartTag(int prefix, String localName) throws IOException, XMLStreamException;
aoqi@0: 
aoqi@0:     public void attribute( Name name, String value ) throws IOException, XMLStreamException {
aoqi@0:         short idx = name.nsUriIndex;
aoqi@0:         if(idx==-1)
aoqi@0:             attribute(-1,name.localName, value);
aoqi@0:         else
aoqi@0:             attribute( nsUriIndex2prefixIndex[idx], name.localName, value );
aoqi@0:     }
aoqi@0:     /**
aoqi@0:      * @param prefix
aoqi@0:      *      -1 if this attribute does not have a prefix
aoqi@0:      *      (this handling differs from that of elements.)
aoqi@0:      */
aoqi@0:     public abstract void attribute( int prefix, String localName, String value ) throws IOException, XMLStreamException;
aoqi@0: 
aoqi@0:     public abstract void endStartTag() throws IOException, SAXException;
aoqi@0: 
aoqi@0:     public void endTag(Name name) throws IOException, SAXException, XMLStreamException {
aoqi@0:         endTag( nsUriIndex2prefixIndex[name.nsUriIndex], name.localName);
aoqi@0:     }
aoqi@0:     public abstract void endTag(int prefix, String localName) throws IOException, SAXException, XMLStreamException;
aoqi@0: 
aoqi@0: 
aoqi@0: 
aoqi@0: 
aoqi@0: //
aoqi@0: //
aoqi@0: // Utilities for implementations
aoqi@0: //
aoqi@0: //
aoqi@0:     /**
aoqi@0:      * The conversion table from the namespace URI index to prefix index.
aoqi@0:      *
aoqi@0:      * This array is shared with {@link XMLSerializer} and
aoqi@0:      * is updated by it automatically.
aoqi@0:      *
aoqi@0:      * This allows {@link Name#nsUriIndex} to be converted to prefix index
aoqi@0:      * (for {@link NamespaceContextImpl}) quickly.
aoqi@0:      */
aoqi@0:     protected int[] nsUriIndex2prefixIndex;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Set by the marshaller before the start tag is written for the root element.
aoqi@0:      */
aoqi@0:     protected NamespaceContextImpl nsContext;
aoqi@0: 
aoqi@0:     protected XMLSerializer serializer;
aoqi@0: }