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

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

import java.io.*;

public final class ObjectURL extends CompareSupport<ObjectURL> implements Serializable {
    private static final long serialVersionUID = 1L;

    private static final String OBJECT_NAME_TO_UNIQUE_KEY_CHAR_SEPARATOR = "(";
    private static final String UNIQUE_KEY_CHAR_TERMINATOR = ")";

    public static final ObjectURL[] EMPTY_ARRAY = new ObjectURL[0];

    public static final char URL_SEPARATOR = '\n';

    private /* final */ String mObjectName;
    private /* final */ ObjectUniqueKey mObjectUniqueKey;
    private /* final */ String mExtra;

    @SuppressWarnings({"deprecation", "UnusedDeclaration"})
    @Deprecated
    /** for Serialization */
    protected ObjectURL() {
    }

    public ObjectURL( String pObjectName, ObjectUniqueKey pObjectUniqueKey, String pExtra ) {
        Confirm.significantAsIs( "ObjectName", mObjectName = pObjectName );
        Confirm.isNotNull( "ObjectUniqueKey", mObjectUniqueKey = pObjectUniqueKey );
        mExtra = ConstrainTo.notNull( pExtra );
        chkBadName( ObjectUniqueKey.PREFIX );
        chkBadName( OBJECT_NAME_TO_UNIQUE_KEY_CHAR_SEPARATOR );
        if ( -1 != mExtra.indexOf( URL_SEPARATOR ) ) {
            throw new IllegalArgumentException( "The Extra ('" + mExtra + "') may not contain a URL_SEPARATOR (\\n)" );
        }
    }

    public ObjectURL( String pObjectName, ObjectUniqueKey pObjectUniqueKey ) {
        this( pObjectName, pObjectUniqueKey, "" );
    }

    private void chkBadName( String pCheckFor ) {
        if ( mObjectName.contains( pCheckFor ) ) {
            throw new IllegalArgumentException( "The Object Name ('" + mObjectName + "') may not contain a '" + pCheckFor + "'" );
        }
    }

    public String getObjectName() {
        return mObjectName;
    }

    public ObjectUniqueKey getObjectUniqueKey() {
        return mObjectUniqueKey;
    }

    public String getExtra() {
        return mExtra;
    }

    public int compareTo( ObjectURL o ) {
        return toString().compareTo( o.toString() );
    }

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

    private boolean equals( ObjectURL them ) {
        return (this == them) || //
               ((them != null) //
                && this.mObjectName.equals( them.mObjectName ) //
                && this.mObjectUniqueKey.equals( them.mObjectUniqueKey ) //
                && this.mExtra.equals( them.mExtra ) //
               );
    }

    public int hashCode() {
        return hashCodeEm( mObjectName.hashCode(), mObjectUniqueKey.hashCode(), mExtra.hashCode() );
    }

    public String toString() {
        return mObjectName + OBJECT_NAME_TO_UNIQUE_KEY_CHAR_SEPARATOR + mObjectUniqueKey + UNIQUE_KEY_CHAR_TERMINATOR + mExtra;
    }

    public static ObjectURL fromString( String pToString )
            throws IllegalArgumentException {
        String pExceptionPlus = "";
        if ( pToString != null ) {
            int zAt = pToString.indexOf( OBJECT_NAME_TO_UNIQUE_KEY_CHAR_SEPARATOR );
            int zTo = pToString.indexOf( UNIQUE_KEY_CHAR_TERMINATOR, zAt + 1 );
            if ( (1 <= zAt) && (zAt < zTo) ) {
                try {
                    String zObjectName = pToString.substring( 0, zAt );
                    ObjectUniqueKey zOUK = ObjectUniqueKey.fromString( pToString.substring( zAt + 1, zTo ) );
                    return new ObjectURL( zObjectName, zOUK, pToString.substring( zTo + 1 ) );
                }
                catch ( IllegalArgumentException e ) {
                    pExceptionPlus = ": " + e;
                }
            }
        }
        throw new IllegalArgumentException( "Unacceptable encoding of ObjectURL ('" + pToString + "')" + pExceptionPlus );
    }

    public static ObjectURL[] prepend( ObjectURL pNewFirst, ObjectURL[] pCurrent ) {
        if ( Currently.isNullOrEmpty( pCurrent ) ) {
            return new ObjectURL[]{pNewFirst};
        }
        ObjectURL[] rv = new ObjectURL[pCurrent.length + 1];
        rv[0] = pNewFirst;
        System.arraycopy( pCurrent, 0, rv, 1, pCurrent.length );
        return rv;
    }
}