LiteLoader / LiteLoader · Files

package com.mumfrey.liteloader.interfaces;

import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Collections;
import java.util.List;
import java.util.Set;

import com.google.common.collect.ImmutableSet;
import com.mumfrey.liteloader.launch.InjectionStrategy;
import com.mumfrey.liteloader.launch.LoaderEnvironment;

import net.minecraft.launchwrapper.LaunchClassLoader;

/**
 * Interface for containers which can be loaded as mods
 * 
 * @author Adam Mummery-Smith
 *
 * @param <L> base class type for Comparable<?> so that implementors can specify
 *      their Comparable type
 */
public interface LoadableMod<L> extends Loadable<L>, Injectable
{
    static final String METADATA_FILENAME = "litemod.json";

    /**
     * Get the mod systems declared in the jar metadata
     */
    public abstract Set<String> getModSystems();

    /**
     * Get the name of the mod
     */
    public abstract String getModName();

    /**
     * Get the target loader version for this mod
     */
    public abstract String getTargetVersion();

    /**
     * Get the revision number for this mod
     */
    public abstract float getRevision();

    /**
     * Get whether this mod's metadata is valid
     */
    public abstract boolean hasValidMetaData();

    /**
     * Get whether this mod has any dependencies 
     */
    public abstract boolean hasDependencies();

    /**
     * Get this mod's list of dependencies
     */
    public abstract Set<String> getDependencies();

    /**
     * Callback to notify the container that it's missing a specific dependency
     */
    public abstract void registerMissingDependency(String dependency);

    /**
     * Get this mod's list of missing dependencies
     */
    public abstract Set<String> getMissingDependencies();

    /**
     * Get this mod's list of required APIs
     */
    public abstract Set<String> getRequiredAPIs();

    /**
     * Callback to notify the container that it's missing a specific required
     * API
     */
    public abstract void registerMissingAPI(String identifier);

    /**
     * Get this mod's list of missing APIs
     */
    public abstract Set<String> getMissingAPIs();

    /**
     * Get the specified metadata value and return the default value if not
     * present
     * 
     * @param metaKey metadata key
     * @param defaultValue metadata value
     */
    public abstract String getMetaValue(String metaKey, String defaultValue);

    /**
     * Get the mod metadata key set
     */
    public abstract Set<String> getMetaDataKeys();

    /**
     * Returns true if this mod can be added as a resource pack
     */
    public abstract boolean hasResources();

    /**
     * Get all class names in this container
     */
    public abstract List<String> getContainedClassNames();

    /**
     * Callback from the enumerator, whenever a mod is registered to this
     * container
     */
    public abstract void addContainedMod(String modName);

    /**
     * Container returned instead of null when a mod does not actually have a
     * container or a container is requested for a mod which doesn't exist.
     */
    public static final LoadableMod<File> NONE = new EmptyModContainer();

    /**
     * Mod container for a mod which doesn't have a container 
     *
     * @author Adam Mummery-Smith
     */
    public class EmptyModContainer implements LoadableMod<File>
    {
        private static final ImmutableSet<String> EMPTY_SET = ImmutableSet.<String>of();

        EmptyModContainer() {}

        @Override
        public File getTarget()
        {
            return null;
        }

        @Override
        public Set<String> getModSystems()
        {
            return EmptyModContainer.EMPTY_SET;
        }

        @Override
        public String getName()
        {
            return "Unknown";
        }

        @Override
        public String getDisplayName()
        {
            return "Unknown";
        }

        @Override
        public String getLocation()
        {
            return ".";
        }

        @Override
        public String getIdentifier()
        {
            return "Unknown";
        }

        @Override
        public String getVersion()
        {
            return "Unknown";
        }

        @Override
        public String getAuthor()
        {
            return "Unknown";
        }

        @Override
        public String getDescription(String key)
        {
            return "";
        }

        @Override
        public boolean isExternalJar()
        {
            return false;
        }

        @Override
        public boolean isToggleable()
        {
            return false;
        }

        @Override
        public boolean isEnabled(LoaderEnvironment environment)
        {
            return true;
        }

        @Override
        public boolean isFile()
        {
            return false;
        }

        @Override
        public boolean isDirectory()
        {
            return false;
        }

        @Override
        public File toFile()
        {
            return null;
        }

        @Override
        public int compareTo(File other)
        {
            return 0;
        }

        @Override
        public URL getURL() throws MalformedURLException
        {
            throw new MalformedURLException("Attempted to get the URL of an empty mod");
        }

        @Override
        public boolean isInjected()
        {
            return false;
        }

        @Override
        public boolean injectIntoClassPath(LaunchClassLoader classLoader, boolean injectIntoParent) throws MalformedURLException
        {
            return false;
        }

        @Override
        public InjectionStrategy getInjectionStrategy()
        {
            return null;
        }

        @Override
        public String getModName()
        {
            return "Unknown";
        }

        @Override
        public String getTargetVersion()
        {
            return "";
        }

        @Override
        public float getRevision()
        {
            return 0;
        }

        @Override
        public boolean hasValidMetaData()
        {
            return false;
        }

        @Override
        public String getMetaValue(String metaKey, String defaultValue)
        {
            return defaultValue;
        }

        @Override
        public Set<String> getMetaDataKeys()
        {
            return Collections.<String>emptySet();
        }

        @Override
        public boolean hasResources()
        {
            return false;
        }

        @Override
        public boolean hasDependencies()
        {
            return false;
        }

        @Override
        public Set<String> getDependencies()
        {
            return Collections.<String>emptySet();
        }

        @Override
        public void registerMissingDependency(String dependency)
        {
        }

        @Override
        public Set<String> getMissingDependencies()
        {
            return Collections.<String>emptySet();
        }

        @Override
        public Set<String> getRequiredAPIs()
        {
            return Collections.<String>emptySet();
        }

        @Override
        public void registerMissingAPI(String identifier)
        {
        }

        @Override
        public Set<String> getMissingAPIs()
        {
            return Collections.<String>emptySet();
        }

        @Override
        public List<String> getContainedClassNames()
        {
            return Collections.<String>emptyList();
        }

        @Override
        public void addContainedMod(String modName)
        {
        }
        
        @Override
        public boolean requiresPreInitInjection()
        {
            return false;
        }
    }
}