/*

 * reserved comment block

 * DO NOT REMOVE OR ALTER!

 */

/*

 * 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: EmptySerializer.java,v 1.2.4.1 2005/09/15 08:15:16 suresh_emailid Exp $

 */

package com.sun.org.apache.xml.internal.serializer;

import java.io.IOException;

import java.io.OutputStream;

import java.io.Writer;

import java.util.Hashtable;

import java.util.Properties;

import java.util.ArrayList;

import javax.xml.transform.SourceLocator;

import javax.xml.transform.Transformer;

import org.w3c.dom.Node;

import org.xml.sax.Attributes;

import org.xml.sax.ContentHandler;

import org.xml.sax.Locator;

import org.xml.sax.SAXException;

import org.xml.sax.SAXParseException;

/**

 * This class is an adapter class. Its only purpose is to be extended and

 * for that extended class to over-ride all methods that are to be used.

 *

 * This class is not a public API, it is only public because it is used

 * across package boundaries.

 *

 * @xsl.usage internal

 */

public class EmptySerializer implements SerializationHandler

{

    protected static final String ERR = "EmptySerializer method not over-ridden";

    /**

     * @see SerializationHandler#asContentHandler()

     */

    protected void couldThrowIOException() throws IOException

    {

        return; // don't do anything.

    }

    protected void couldThrowSAXException() throws SAXException

    {

        return; // don't do anything.

    }

    protected void couldThrowSAXException(char[] chars, int off, int len) throws SAXException

    {

        return; // don't do anything.

    }

    protected void couldThrowSAXException(String elemQName) throws SAXException

    {

        return; // don't do anything.

    }

    protected void couldThrowException() throws Exception

    {

        return; // don't do anything.

    }

    void aMethodIsCalled()

    {

        // throw new RuntimeException(err);

        return;

    }

    /**

     * @see SerializationHandler#asContentHandler()

     */

    public ContentHandler asContentHandler() throws IOException

    {

        couldThrowIOException();

        return null;

    }

    /**

     * @see SerializationHandler#setContentHandler(org.xml.sax.ContentHandler)

     */

    public void setContentHandler(ContentHandler ch)

    {

        aMethodIsCalled();

    }

    /**

     * @see SerializationHandler#close()

     */

    public void close()

    {

        aMethodIsCalled();

    }

    /**

     * @see SerializationHandler#getOutputFormat()

     */

    public Properties getOutputFormat()

    {

        aMethodIsCalled();

        return null;

    }

    /**

     * @see SerializationHandler#getOutputStream()

     */

    public OutputStream getOutputStream()

    {

        aMethodIsCalled();

        return null;

    }

    /**

     * @see SerializationHandler#getWriter()

     */

    public Writer getWriter()

    {

        aMethodIsCalled();

        return null;

    }

    /**

     * @see SerializationHandler#reset()

     */

    public boolean reset()

    {

        aMethodIsCalled();

        return false;

    }

    /**

     * @see SerializationHandler#serialize(org.w3c.dom.Node)

     */

    public void serialize(Node node) throws IOException

    {

        couldThrowIOException();

    }

    /**

     * @see SerializationHandler#setCdataSectionElements(java.util.ArrayList<String>)

     */

    public void setCdataSectionElements(ArrayList<String> URI_and_localNames)

    {

        aMethodIsCalled();

    }

    /**

     * @see SerializationHandler#setEscaping(boolean)

     */

    public boolean setEscaping(boolean escape) throws SAXException

    {

        couldThrowSAXException();

        return false;

    }

    /**

     * @see SerializationHandler#setIndent(boolean)

     */

    public void setIndent(boolean indent)

    {

        aMethodIsCalled();

    }

    /**

     * @see SerializationHandler#setIndentAmount(int)

     */

    public void setIndentAmount(int spaces)

    {

        aMethodIsCalled();

    }

    /**

     * @see SerializationHandler#setIsStandalone(boolean)

     */

    public void setIsStandalone(boolean isStandalone)

    {

        aMethodIsCalled();

    }

    /**

     * @see SerializationHandler#setOutputFormat(java.util.Properties)

     */

    public void setOutputFormat(Properties format)

    {

        aMethodIsCalled();

    }

    /**

     * @see SerializationHandler#setOutputStream(java.io.OutputStream)

     */

    public void setOutputStream(OutputStream output)

    {

        aMethodIsCalled();

    }

    /**

     * @see SerializationHandler#setVersion(java.lang.String)

     */

    public void setVersion(String version)

    {

        aMethodIsCalled();

    }

    /**

     * @see SerializationHandler#setWriter(java.io.Writer)

     */

    public void setWriter(Writer writer)

    {

        aMethodIsCalled();

    }

    /**

     * @see SerializationHandler#setTransformer(javax.xml.transform.Transformer)

     */

    public void setTransformer(Transformer transformer)

    {

        aMethodIsCalled();

    }

    /**

     * @see SerializationHandler#getTransformer()

     */

    public Transformer getTransformer()

    {

        aMethodIsCalled();

        return null;

    }

    /**

     * @see SerializationHandler#flushPending()

     */

    public void flushPending() throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see ExtendedContentHandler#addAttribute(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

     */

    public void addAttribute(

        String uri,

        String localName,

        String rawName,

        String type,

        String value,

        boolean XSLAttribute)

        throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see ExtendedContentHandler#addAttributes(org.xml.sax.Attributes)

     */

    public void addAttributes(Attributes atts) throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see ExtendedContentHandler#addAttribute(java.lang.String, java.lang.String)

     */

    public void addAttribute(String name, String value)

    {

        aMethodIsCalled();

    }

    /**

     * @see ExtendedContentHandler#characters(java.lang.String)

     */

    public void characters(String chars) throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see ExtendedContentHandler#endElement(java.lang.String)

     */

    public void endElement(String elemName) throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see ExtendedContentHandler#startDocument()

     */

    public void startDocument() throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see ExtendedContentHandler#startElement(java.lang.String, java.lang.String, java.lang.String)

     */

    public void startElement(String uri, String localName, String qName)

        throws SAXException

    {

        couldThrowSAXException(qName);

    }

    /**

     * @see ExtendedContentHandler#startElement(java.lang.String)

     */

    public void startElement(String qName) throws SAXException

    {

        couldThrowSAXException(qName);

    }

    /**

     * @see ExtendedContentHandler#namespaceAfterStartElement(java.lang.String, java.lang.String)

     */

    public void namespaceAfterStartElement(String uri, String prefix)

        throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see ExtendedContentHandler#startPrefixMapping(java.lang.String, java.lang.String, boolean)

     */

    public boolean startPrefixMapping(

        String prefix,

        String uri,

        boolean shouldFlush)

        throws SAXException

    {

        couldThrowSAXException();

        return false;

    }

    /**

     * @see ExtendedContentHandler#entityReference(java.lang.String)

     */

    public void entityReference(String entityName) throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see ExtendedContentHandler#getNamespaceMappings()

     */

    public NamespaceMappings getNamespaceMappings()

    {

        aMethodIsCalled();

        return null;

    }

    /**

     * @see ExtendedContentHandler#getPrefix(java.lang.String)

     */

    public String getPrefix(String uri)

    {

        aMethodIsCalled();

        return null;

    }

    /**

     * @see ExtendedContentHandler#getNamespaceURI(java.lang.String, boolean)

     */

    public String getNamespaceURI(String name, boolean isElement)

    {

        aMethodIsCalled();

        return null;

    }

    /**

     * @see ExtendedContentHandler#getNamespaceURIFromPrefix(java.lang.String)

     */

    public String getNamespaceURIFromPrefix(String prefix)

    {

        aMethodIsCalled();

        return null;

    }

    /**

     * @see org.xml.sax.ContentHandler#setDocumentLocator(org.xml.sax.Locator)

     */

    public void setDocumentLocator(Locator arg0)

    {

        aMethodIsCalled();

    }

    /**

     * @see org.xml.sax.ContentHandler#endDocument()

     */

    public void endDocument() throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see org.xml.sax.ContentHandler#startPrefixMapping(java.lang.String, java.lang.String)

     */

    public void startPrefixMapping(String arg0, String arg1)

        throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see org.xml.sax.ContentHandler#endPrefixMapping(java.lang.String)

     */

    public void endPrefixMapping(String arg0) throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see org.xml.sax.ContentHandler#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

     */

    public void startElement(

        String arg0,

        String arg1,

        String arg2,

        Attributes arg3)

        throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see org.xml.sax.ContentHandler#endElement(java.lang.String, java.lang.String, java.lang.String)

     */

    public void endElement(String arg0, String arg1, String arg2)

        throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see org.xml.sax.ContentHandler#characters(char[], int, int)

     */

    public void characters(char[] arg0, int arg1, int arg2) throws SAXException

    {

        couldThrowSAXException(arg0, arg1, arg2);

    }

    /**

     * @see org.xml.sax.ContentHandler#ignorableWhitespace(char[], int, int)

     */

    public void ignorableWhitespace(char[] arg0, int arg1, int arg2)

        throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see org.xml.sax.ContentHandler#processingInstruction(java.lang.String, java.lang.String)

     */

    public void processingInstruction(String arg0, String arg1)

        throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see org.xml.sax.ContentHandler#skippedEntity(java.lang.String)

     */

    public void skippedEntity(String arg0) throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see ExtendedLexicalHandler#comment(java.lang.String)

     */

    public void comment(String comment) throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see org.xml.sax.ext.LexicalHandler#startDTD(java.lang.String, java.lang.String, java.lang.String)

     */

    public void startDTD(String arg0, String arg1, String arg2)

        throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see org.xml.sax.ext.LexicalHandler#endDTD()

     */

    public void endDTD() throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see org.xml.sax.ext.LexicalHandler#startEntity(java.lang.String)

     */

    public void startEntity(String arg0) throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see org.xml.sax.ext.LexicalHandler#endEntity(java.lang.String)

     */

    public void endEntity(String arg0) throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see org.xml.sax.ext.LexicalHandler#startCDATA()

     */

    public void startCDATA() throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see org.xml.sax.ext.LexicalHandler#endCDATA()

     */

    public void endCDATA() throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see org.xml.sax.ext.LexicalHandler#comment(char[], int, int)

     */

    public void comment(char[] arg0, int arg1, int arg2) throws SAXException

    {

        couldThrowSAXException();

    }

    /**

     * @see XSLOutputAttributes#getDoctypePublic()

     */

    public String getDoctypePublic()

    {

        aMethodIsCalled();

        return null;

    }

    /**

     * @see XSLOutputAttributes#getDoctypeSystem()

     */

    public String getDoctypeSystem()

    {

        aMethodIsCalled();

        return null;

    }

    /**

     * @see XSLOutputAttributes#getEncoding()

     */

    public String getEncoding()

    {

        aMethodIsCalled();

        return null;

    }

    /**

     * @see XSLOutputAttributes#getIndent()

     */

    public boolean getIndent()