package wox.serial;

import java.lang.reflect.*;

/**
 * Version: 1.0
 * Author: Carlos R. Jaimez Gonzalez
 * Author: Simon M. Lucas
 * Site: http://woxserializer.sourceforge.net/
 *
 * Version: 1.5
 * Author: Steven M Lewis
 *
 * Version: 2.0
 * Author: George Smith
 * SVN: http://svn.xp-dev.com/svn/WOX2/
 * Note: XML form for vs 2 is more compact and therefor incompatible with vs 1
 */

public interface WoxHandler
{
    Class getNativeTypeFor( WoxHandlers pWoxHandlers, String pWoxType );

    String getWoxTypeFor( WoxHandlers pWoxHandlers, Class pType, Field pField, boolean pJustType );

    /**
     * Return list of WoxTypes to Handle for ReadObject.  Null means it should be asked, empty means it handles none?
     */
    String[] getForReadObjectWoxTypeNames();

    boolean willReadObjectForWoxType( String pWoxType );

    Object readObject( WoxHandlers pWoxHandlers, WoxReader pWoxReader, XMLreader pReader );

    void writeObject( WoxHandlers pWoxHandlers, WoxWriter pWoxWriter, Object pObject, Field pField, XMLwriter pWriter, boolean pJustType );

    /**
     * Return list of WoxTypes to Handle for ReadObject.  Null means it should be asked, empty means it handles none?
     */
    String[] getForParseFieldValueWoxTypeNames();

    boolean willParseFieldValueForWoxType( String pWoxType );

    Object parseFieldValue( String pFieldValue );

    /**
     * @return null indicates FieldValue not supported by this Handler
     */
    String createFieldValue( Object pFieldValue );

    /**
     * Always returns "false" unless
     * WillParseFieldValueForWoxType would have returned true &&
     * CreateFieldValue would have returned !null &&
     * CreateFieldValue would NEVER return a value with a space in it!
     */
    boolean willFieldValueNeverHaveAnySpaces();

    Object createArrayFor( Class pFieldElementType, String[] pValues );

    Object getNonNullDefaultValue();

    boolean supportsJustTypeWriting();
}