// This Source Code is in the Public Domain per: http://litesoft.org/License.txt
package org.litesoft.uispecification;

import java.io.*;

import org.litesoft.core.simpletypes.nonpublic.*;
import org.litesoft.core.util.*;

public final class ViewDef extends EqualSupport implements Serializable
{
    public static final ViewDef HOME = new ViewDef( "Home" );

    private final String mFragmentID;
    private final String mUiString;

    /**
     * Each "page" has a unique identifier which is part of the uri's FragmentID, this is
     * created from the passed UiString.
     *
     * @param pUiString the text displayed to the user, which in turn is transformed into FragmentID.
     */
    public ViewDef( String pUiString )
    {
        this( ParameterizedUriFragmentId.transformToValidFragmentReference( pUiString ), pUiString );
    }

    /**
     * Each "page" has a unique identifier which is part of the uri's FragmentID.
     *
     * @param pFragmentID a unique identifier (part of the uri's FragmentID) which can appear in the
     *                    location bar of the browser (no funny characters or spaces?).
     * @param pUiString   the text displayed to the user
     */
    public ViewDef( String pFragmentID, String pUiString )
    {
        mFragmentID = UtilsCommon.assertNotNullNotEmpty( "FragmentID", pFragmentID );
        mUiString = UtilsCommon.assertNotNullNotEmpty( "UiString", pUiString );
    }

    public String getFragmentID()
    {
        return mFragmentID;
    }

    public String getUiString()
    {
        return mUiString;
    }

    @Override
    public int hashCode()
    {
        return mFragmentID.hashCode();
    }

    public boolean equals( ViewDef pThem )
    {
        return (this == pThem) || //
               ((pThem != null) //
                && equal( this.mFragmentID, pThem.mFragmentID ) //
               );
    }

    @Override
    public boolean equals( Object o )
    {
        return (this == o) || //
               ((o instanceof ViewDef) && equals( (ViewDef) o ));
    }

    @Override public String toString()
    {
        return mUiString;
    }
}