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

import java.io.*;

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

public final class SerializableSystemUserRef extends CompareSupport implements Serializable
{
    private String mDisplayName;
    private String mKeyAsOpaqueString;

    public SerializableSystemUserRef( String pDisplayName, String pKeyAsOpaqueString )
    {
        mDisplayName = pDisplayName;
        mKeyAsOpaqueString = pKeyAsOpaqueString;
    }

    private SerializableSystemUserRef( ISystemUser pSystemUserNotNull )
    {
        this( pSystemUserNotNull.getDisplayName(), pSystemUserNotNull.getKeyAsOpaqueString() );
    }

    public static SerializableSystemUserRef createFrom( ISystemUser pSystemUser )
    {
        return new SerializableSystemUserRef( (pSystemUser != null) ? pSystemUser : ISystemUser.NULL );
    }

    public String getDisplayName()
    {
        return mDisplayName;
    }

    public String getKeyAsOpaqueString()
    {
        return mKeyAsOpaqueString;
    }

    public boolean equals( SerializableSystemUserRef them )
    {
        return (this == them) || ((them != null) //
                                  && equal( this.mKeyAsOpaqueString, them.mKeyAsOpaqueString ) //
        );
    }

    public int hashCode()
    {
        return calcHashCode( mKeyAsOpaqueString );
    }

    /**
     * Note: Comparable & Equals contract inconsistent
     */
    public int compareTo( Object o )
    {
        return compare( this.mDisplayName, ((SerializableSystemUserRef) o).mDisplayName );
    }

    /**
     * Note: Comparable & Equals contract inconsistent
     */
    public boolean equals( Object o )
    {
        return (this == o) ||
               ((o instanceof SerializableSystemUserRef) && equals( (SerializableSystemUserRef) o ));
    }

    public String toString()
    {
        return mDisplayName;
    }

    static final long serialVersionUID = -123467234673426728L;

    @Deprecated // for serialization
    public SerializableSystemUserRef()
    {
    }
}