/*
 * This class was automatically generated with 
 * <a href="http://www.castor.org">Castor 0.9.7</a>, using an XML
 * Schema.
 * $Id$
 */

package com.queplix.core.jxb.entity.types;

//---------------------------------/
//- Imported classes and packages -/
//---------------------------------/

import java.util.Hashtable;

/**
 * The possible join types of joining entity field with list field
 *
 * @version $Revision$ $Date$
 */
public class JoinSType implements java.io.Serializable {

    //--------------------------/
    //- Class/Member Variables -/
    //--------------------------/

    /**
     * The default type
     */
    public static final int DEFAULT_TYPE = 0;

    /**
     * The instance of the default type
     */
    public static final JoinSType DEFAULT = new JoinSType(DEFAULT_TYPE,
            "default");

    /**
     * The use_cache type
     */
    public static final int USE_CACHE_TYPE = 1;

    /**
     * The instance of the use_cache type
     */
    public static final JoinSType USE_CACHE = new JoinSType(USE_CACHE_TYPE,
            "use_cache");

    /**
     * Field _memberTable
     */
    private static java.util.Hashtable _memberTable = init();

    /**
     * Field type
     */
    private int type = -1;

    /**
     * Field stringValue
     */
    private java.lang.String stringValue = null;

    //----------------/
    //- Constructors -/
    //----------------/

    private JoinSType(int type, java.lang.String value) {
        super();
        this.type = type;
        this.stringValue = value;
    } //-- com.queplix.core.jxb.entity.types.JoinSType(int, java.lang.String)

    //-----------/
    //- Methods -/
    //-----------/

    /**
     * Method enumerate
     * <p/>
     * Returns an enumeration of all possible instances of
     * JoinSType
     *
     * @return Enumeration
     */
    public static java.util.Enumeration enumerate() {
        return _memberTable.elements();
    } //-- java.util.Enumeration enumerate() 

    /**
     * Method getType
     * <p/>
     * Returns the type of this JoinSType
     *
     * @return int
     */
    public int getType() {
        return this.type;
    } //-- int getType() 

    /**
     * Method init
     *
     * @return Hashtable
     */
    private static java.util.Hashtable init() {
        Hashtable members = new Hashtable();
        members.put("default", DEFAULT);
        members.put("use_cache", USE_CACHE);
        return members;
    } //-- java.util.Hashtable init() 

    /**
     * Method readResolve
     * <p/>
     * will be called during deserialization to replace the
     * deserialized object with the correct constant instance.
     * <br/>
     *
     * @return Object
     */
    private java.lang.Object readResolve() {
        return valueOf(this.stringValue);
    } //-- java.lang.Object readResolve() 

    /**
     * Method toString
     * <p/>
     * Returns the String representation of this JoinSType
     *
     * @return String
     */
    public java.lang.String toString() {
        return this.stringValue;
    } //-- java.lang.String toString() 

    /**
     * Method valueOf
     * <p/>
     * Returns a new JoinSType based on the given String value.
     *
     * @param string
     * @return JoinSType
     */
    public static com.queplix.core.jxb.entity.types.JoinSType valueOf(
            java.lang.String string) {
        java.lang.Object obj = null;
        if(string != null) {
            obj = _memberTable.get(string);
        }
        if(obj == null) {
            String err = "'" + string + "' is not a valid JoinSType";
            throw new IllegalArgumentException(err);
        }
        return (JoinSType) obj;
    } //-- com.queplix.core.jxb.entity.types.JoinSType valueOf(java.lang.String) 

}
