// This Source Code is in the Public Domain per: http://litesoft.org/License.txt
package org.litesoft.ui.def.nonpublic.support;

import org.litesoft.commonfoundation.base.*;
import org.litesoft.commonfoundation.typeutils.*;
import org.litesoft.ui.support.*;

public class ActionMetaData extends AbstractSharedMetaData
{
    public static final long serialVersionUID = -7834236754236734267L;

    private String mActionID;

    /**
     * @deprecated GWT ONLY
     */
    public ActionMetaData()
    {
    }

    public ActionMetaData( ActionUsage pUsage, boolean pDisabled, String pExternalText, String pTooltip )
    {
        super( pUsage, pDisabled, pExternalText, pTooltip );
        mActionID = pUsage.getActionID();
    }

    public ActionMetaData( String pActionID, boolean pDisabled, String pExternalText, String pTooltip )
    {
        super( pDisabled, pExternalText, pTooltip );
        mActionID = Strings.assertNotNullNotEmpty( "ActionID", pActionID );
    }

    public String getActionID()
    {
        return mActionID;
    }

    public boolean equals( Object o )
    {
        return (this == o) || ((o instanceof ActionMetaData) && equals( (ActionMetaData) o ));
    }

    public boolean equals( ActionMetaData them )
    {
        return (this == them) || ((them != null) //
                                  && Objects.areNonArraysEqual( this.mActionID, them.mActionID ) //
                                  && Booleans.areNonArraysEqual( this.isDisabled(), them.isDisabled() ) //
        );
    }

    public int hashCode()
    {
        return mActionID.hashCode();
    }

    public int compareTo( ActionMetaData pThem )
    {
        return Compare.first( this.mActionID, pThem.mActionID //
        ).then( this.isDisabled(), pThem.isDisabled() //
        ).result();
    }

    public int compareTo( Object pObject )
    {
        return compareTo( (ActionMetaData) pObject );
    }

    public String toString()
    {
        return toStringBuilder( new StringBuilder().append( "ActionMetaData-" ), 0 ).toString();
    }

    public StringBuilder toStringBuilder( StringBuilder pSB, int pDepth )
    {
        pSB.append( "'" ).append( mActionID ).append( "'" );
        if ( isDisabled() )
        {
            pSB.append( "[Disabled]" );
        }
        return pSB.append( "->'" ).append( getExternalText() ).append( "','" ).append( getTooltip() ).append( "'" );
    }
}