/* Copyright (c) 2005 Ricebridge. All Rights Reserved.
 *
 * This file is available under the terms and conditions of the
 * Ricebridge "Open Source API" policy; Ricebridge grants use of this
 * copyrighted work under the terms of a BSD-style license only. See
 * http://www.opensource.org/licenses/bsd-license.php for more
 * information.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 *  - Redistributions of source code must retain the above copyright
 *  notice, this list of conditions and the following disclaimer.
 *
 *  - Redistributions in binary form must reproduce the above
 *  copyright notice, this list of conditions and the following
 *  disclaimer in the documentation and/or other materials provided
 *  with the distribution.
 *
 *  - Neither the name of the Ricebridge nor the names of its
 *  contributors may be used to endorse or promote products derived
 *  from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.  
 */

package com.ricebridge.xmlman;


import org.jostraca.util.Internal;

import java.util.*;


/** Helper class that enables the functionality of the {@link XmlManager#getBadRecords getBadRecords} method.
 *    <p>Extend this class if you intend to store {@link BadRecord BadRecords}, so that they can then be accessed
 *  by {@link XmlManager}. See the {@link StandardBadRecordListener} for an implementation example.</p>
 *    <p>The <b><a href="CollectingBadRecordListener.java.html">Source Code</a></b> of this Java class 
 *    is available under a <a href="http://www.opensource.org/licenses/bsd-license.php">BSD-style license</a>.</p>
 */
public abstract class CollectingBadRecordListener extends BadRecordListenerSupport {

  // public methods

  /** Get the list of stored {@link BadRecord BadRecords}. */
  public List getBadRecords() {
    List badrecs = null;

    try {
      badrecs = getBadRecordsImpl();
    }
    catch( XmlManagerException xme ) { throw xme; }
    catch( Exception e ) {
      throw new XmlManagerException( XmlManagerException.CODE_getbadrecs, e );
    }

    if( null == badrecs ) {
      badrecs = new ArrayList();
    }
    return badrecs;
  }


  // protected methods

  /** Get the stored {@link BadRecord BadRecords} from the underlying implementation. */
  protected abstract List getBadRecordsImpl();
  
}