SquirrelJME/SquirrelJME

// -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
// ---------------------------------------------------------------------------
// SquirrelJME
//     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
// ---------------------------------------------------------------------------
// SquirrelJME is under the Mozilla Public License Version 2.0.
// See license.mkd for licensing and copyright information.
// ---------------------------------------------------------------------------

package cc.squirreljme.jvm.suite;

import java.lang.ref.Reference;
import java.lang.ref.WeakReference;
import java.util.Objects;

/**
 * This represents an entry point of a JAR.
 *
 * @since 2017/08/20
 */
public final class EntryPoint
    implements Comparable<EntryPoint>
{
    /** The name of the entry point. */
    protected final String name;
    
    /** The entry point class. */
    protected final String entry;
    
    /** The image used. */
    protected final String imageResource;
    
    /** Is this a midlet? */
    protected final boolean isMidlet;
    
    /** String representation. */
    private Reference<String> _string;
    
    /**
     * Initializes the entry point.
     *
     * @param __name The name of the entry point.
     * @param __entry The class used for entry.
     * @param __imgRc The image resource to use, may be {@code null}.
     * @param __mid Is this a midlet launch?
     * @throws NullPointerException On null arguments.
     * @since 2017/08/20
     */
    public EntryPoint(String __name, String __entry, String __imgRc,
        boolean __mid)
        throws NullPointerException
    {
        // Check
        if (__name == null || __entry == null)
            throw new NullPointerException("NARG");
        
        // Set
        this.name = __name;
        this.entry = __entry;
        this.isMidlet = __mid;
        
        // This may include an absolute path, however that can be stripped off
        this.imageResource = (__imgRc == null ? null :
            (__imgRc.startsWith("/") ? __imgRc.substring(1) :
                __imgRc));
    }
    
    /**
     * {@inheritDoc}
     * @since 2017/08/20
     */
    @Override
    public int compareTo(EntryPoint __o)
    {
        // Do non-midlets first
        boolean ma = this.isMidlet,
            mb = __o.isMidlet;
        if (ma != mb)
            if (!ma)
                return -1;
            else
                return 1;
        
        // Then the rest
        int rv = this.name.compareTo(__o.name);
        if (rv != 0)
            return rv;
        return this.entry.compareTo(__o.entry);
    }
    
    /**
     * Returns the entry point class of the entry point.
     *
     * @return The entry point class.
     * @since 2017/08/20
     */
    public String entryPoint()
    {
        return this.entry;
    }
    
    /**
     * {@inheritDoc}
     * @since 2017/08/20
     */
    @Override
    public boolean equals(Object __o)
    {
        // Check
        if (!(__o instanceof EntryPoint))
            return false;
        
        EntryPoint o = (EntryPoint)__o;
        return this.name.equals(o.name) &&
            this.entry.equals(o.entry) &&
            Objects.equals(this.imageResource, o.imageResource) &&
            this.isMidlet == o.isMidlet;
    }
    
    /**
     * {@inheritDoc}
     * @since 2017/08/20
     */
    @Override
    public int hashCode()
    {
        String imageResource = this.imageResource;
        return this.name.hashCode() ^ this.entry.hashCode() ^
            (this.isMidlet ? 1 : 0) ^
            (imageResource == null ? 0 : imageResource.hashCode());
    }
    
    /**
     * Returns the image to use.
     * 
     * @return The image resource or {@code null} if there is none.
     * @since 2020/10/31
     */
    public String imageResource()
    {
        return this.imageResource;
    }
    
    /**
     * Is this a MIDlet?
     *
     * @return If this is a MIDlet or not.
     * @since 2017/08/20
     */
    public boolean isMidlet()
    {
        return this.isMidlet;
    }
    
    /**
     * Returns the name of the entry point.
     *
     * @return The entry point name.
     * @since 2017/08/20
     */
    public String name()
    {
        return this.name;
    }
    
    /**
     * {@inheritDoc}
     * @since 2017/08/20
     */
    @Override
    public String toString()
    {
        Reference<String> ref = this._string;
        String rv;
        
        // Cache?
        if (ref == null || null == (rv = ref.get()))
            this._string = new WeakReference<>((rv = String.format(
                "%s (%s: %s)", this.name, (this.isMidlet ? "MIDlet" :
                "Classic"), this.entry)));
        
        return rv;
    }
}