/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 2003 The Apache Software Foundation.  All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
*
* 2. 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.
*
* 3. The end-user documentation included with the redistribution,
*    if any, must include the following acknowledgment:
*       "This product includes software developed by the
*        Apache Software Foundation (http://www.apache.org/)."
*    Alternately, this acknowledgment may appear in the software itself,
*    if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" must
*    not be used to endorse or promote products derived from this
*    software without prior written permission. For written
*    permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache
*    XMLBeans", nor may "Apache" appear in their name, without prior
*    written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR
* ITS 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 2000-2003 BEA Systems
* Inc., <http://www.bea.com/>. For more information on the Apache Software
* Foundation, please see <http://www.apache.org/>.
*/

package org.apache.xmlbeans.impl.marshal;

import org.apache.xmlbeans.impl.binding.bts.BindingLoader;

/**
 * A TypeUnmarshaller knows how to unmarshal an xml
 * instance of a given BindingType
 */
interface TypeUnmarshaller
{
    /**
     * Unmarshalls the current node in the xml into a java object.
     * The UnmarshalContext must be pointing at the start element of the node
     * to be unmarshalled (such that XmlStreamReader.isStarteElement()
     * returns true).  The unmarshal method must consume the entire contents
     * of that node including the matching end element.
     *
     * @param context  contains that state of the document unmarshal process
     * @return  Object representing the converted xml
     */
    Object unmarshal(UnmarshalContext context);

    /**
     * unmarshal the lexical value of an instance of xsd:anySimpleType.
     * This could be called on an attribute value or on element content.
     *
     * @param lexicalValue
     * @param context
     * @return Object representing java value of lexical
     *
     * @exception UnsupportedOperationException if the
     *            <tt>unmarshalSimpleType</tt> operation is not supported
     *            by this TypeUnmarshaller.
     */
    Object unmarshalSimpleType(CharSequence lexicalValue,
                               UnmarshalContext context);


    /**
     * called once per object before first use.
     *
     * @param typeTable
     * @param bindingLoader
     */
    void initialize(RuntimeBindingTypeTable typeTable,
                    BindingLoader bindingLoader);
}