/* 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.data.sc;


import com.ricebridge.data.DataException;

import com.ricebridge.util.txt.MakeList;

import java.util.*;


/** Support class for the <code>StringConverter</code> interface.
 *    <p>Concrete implementations should extend this class, so that future interface
 *  compatibility can be protected.</p>
 *    <p>For normal use, extend the {@link DefaultStringConverter} subclass of this class, as it
 *  provides error handling support.</p>
 *    <p>The <b><a href="StringConverterSupport.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>
 *  @see StringConverter
 *  @see DefaultStringConverter
 */
public abstract class StringConverterSupport implements StringConverter {

  /** Helper implementation of {@link StringConverter#makeObject StringConverter.makeObject}. 
   *  Subclasses should implement {@link #makeObjectImpl makeObjectImpl}.
   */
  public Object makeObject( String pValue, boolean pUseDefault ) {
    try {
      return makeObjectImpl( pValue, pUseDefault );
    }
    catch( DataException de ) { throw de; }
    catch( Exception e ) {
      throw new DataException( DataException.CODE_sc_object, new String[] {"value",pValue,"string-converter",getClass().getName()} );
    }
  }


  /** Helper implementation of {@link StringConverter#makeDefaultObject}. 
   *  Subclasses should implement {@link #makeDefaultObjectImpl}.
   */
  public Object makeDefaultObject() {
    try {
      return makeDefaultObjectImpl();
    }
    catch( DataException de ) { throw de; }
    catch( Exception e ) {
      throw new DataException( DataException.CODE_sc_def_obj, new String[] {"string-converter",getClass().getName()} );
    }
  }


  /** Helper implementation of {@link StringConverter#makeString StringConverter.makeString}. 
   *  Subclasses should implement {@link #makeStringImpl makeStringImpl}.
   */
  public String makeString( Object pValue, boolean pUseDefault ) {
    try {
      return makeStringImpl( pValue, pUseDefault );
    }
    catch( DataException de ) { throw de; }
    catch( Exception e ) {
      String value = "[unknown]";
      try {
        value = String.valueOf(pValue);
      }
      catch( Exception se ) {
        value = se.getMessage();
      }
      throw new DataException( DataException.CODE_sc_string, new String[] {"value",value,"string-converter",getClass().getName()} );
    }
  }


  /** Helper implementation of {@link StringConverter#makeDefaultString}. 
   *  Subclasses should implement {@link #makeDefaultStringImpl}.
   */
  public String makeDefaultString() {
    try {
      return makeDefaultStringImpl();
    }
    catch( DataException de ) { throw de; }
    catch( Exception e ) {
      throw new DataException( DataException.CODE_sc_def_str, new String[] {"string-converter",getClass().getName()} );
    }
  }


  // protected

  /** Implement this method to create a new object from a <code>String</code>.
   *  @see #makeObject
   *  @see StringConverter#makeObject
   */
  protected abstract Object makeObjectImpl( String pValue, boolean pUseDefault ) throws Exception;


  /** Implement this method to create a default object.
   *  @see #makeDefaultObject
   *  @see StringConverter#makeDefaultObject
   */
  protected abstract Object makeDefaultObjectImpl() throws Exception;


  /** Implement this method to create a new <code>String</code> from a object.
   *  @see #makeString
   *  @see StringConverter#makeString
   */
  protected abstract String makeStringImpl( Object pValue, boolean pUseDefault ) throws Exception;


  /** Implement this method to create a default <code>String</code>.
   *  @see #makeDefaultString
   *  @see StringConverter#makeDefaultString
   */
  protected abstract String makeDefaultStringImpl() throws Exception;

}