ContentHandlerAdapter.java

/*
 * Copyright (C) 2011 Laurent Caillette
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation, either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.novelang.outfit.xml;

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

/**
 * A {@code ContentHandler} doing nothing.
 *
 * @author Laurent Caillette
 */
public class ContentHandlerAdapter implements ContentHandler {


  private Locator locator = null ;

  /**
   * Don't forget to call {@code super...} when overriding.
   */
  @Override
  public void setDocumentLocator( final Locator locator ) {
    this.locator = locator ;
  }

  /**
   * Convenience implementation for tests.
   *
   * @return the same value as for last call of {@link #setDocumentLocator(org.xml.sax.Locator)},
   *        or null.
   */
  protected final Locator getDocumentLocator() {
    return locator ;
  }


  @Override
  public void startPrefixMapping( final String prefix, final String uri ) throws SAXException { }

  @Override
  public void endPrefixMapping( final String prefix ) throws SAXException { }

  @Override
  public void startDocument() throws SAXException { }

  @Override
  public void endDocument() throws SAXException { }

  @Override
  public void startElement(
      final String uri,
      final String localName,
      final String qName,
      final Attributes attributes
  ) throws SAXException { }

  @Override
  public void endElement(
      final String uri,
      final String localName,
      final String qName
  ) throws SAXException { }

  @Override
  public void characters(
      final char[] ch,
      final int start,
      final int length
  ) throws SAXException { }

  @Override
  public void ignorableWhitespace(
      final char[] ch,
      final int start,
      final int length
  ) throws SAXException { }

  @Override
  public void processingInstruction(
      final String target,
      final String data
  ) throws SAXException { }

  @Override
  public void skippedEntity( final String name ) throws SAXException { }

  
  public static final ContentHandler NULL = new ContentHandlerAdapter() ;


}