/* 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 java.util.*;


/** Convert an object into a String and back again.
 *    <p>This interface represents a general interface for converting objects into
 *  a well-defined textual representation, and for converting that textual representation
 *  back into an object instance.</p>
 *    <p>When implementing your own <code>StringConverter</code>, you should extend the {@link DefaultStringConverter} class, as this
 *  handles errors and default values automatically.</p>
 *    <p>The <b><a href="StringConverter.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 StringConverterSupport
 *  @see DefaultStringConverter
 */
public interface StringConverter {

  /** Create an object from a textual representation.
   *    <p>If the <code>String</code> is invalid, 
   *         then if the <code>pUseDefault</code> argument is <code>true</code>, 
   *           return the default object, as returned by {@link #makeDefaultObject},
   *         otherwise throw an <code>Exception</code>.</p>
   *  @param pValue textual representation of the object
   *  @param pUseDefault use the default value in case of error
   */
  public Object makeObject( String pValue, boolean pUseDefault );


  /** Create a default instance of the object. */
  public Object makeDefaultObject();


  /** Create a textual representation of an object.
   *    <p>If the object is invalid, 
   *         then if the <code>pUseDefault</code> argument is <code>true</code>, 
   *           return the default text, as returned by {@link #makeDefaultString},
   *         otherwise throw an <code>Exception</code>.</p>
   *  @param pValue object to convert
   *  @param pUseDefault use the default value in case of error
   */
  public String makeString( Object pValue, boolean pUseDefault );

  
  /** Create a default textual representation. */
  public String makeDefaultString();

}