com.github.mrivanplays.acf.api.ACFBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of IvanACF Show documentation

API Component of BungeeCord BossBar API created by MrIvanPlays

There is a newer version: 1.7.0

/*
 * *
 *  * Copyright 2018-2019 MrIvanPlays
 *  * 
 *  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
 *  * to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
 *  * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *  * 

 *  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *  * 
 *  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 *  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

package com.github.mrivanplays.acf.api;

import com.google.common.base.Preconditions;

/**
 * Represents a builder
 * to build everything up
 */
public abstract class ACFBuilder {
    /**
     * Class instance
     */
    private static ACFBuilder instance;

    /**
     * Get instance of this class
     *
     * @return instance of this class
     */
    public static ACFBuilder getInstance(){
        return instance;
    }

    /**
     * Sets instance of this class
     *
     * @param instance new instance
     */
    public static void setInstance(ACFBuilder instance){
        Preconditions.checkNotNull(instance, "instance");
        Preconditions.checkArgument(ACFBuilder.instance == null, "Instance already set");
        ACFBuilder.instance = instance;
    }

    /**
     * Gets the register handler for command registering
     *
     * @return register handler
     */
    public abstract ACFCommandHandler getRegisterHandler();

    /**
     * Gets the API version of the plugin
     *
     * @return api version
     */
    public abstract String getAPIVersion();
}