com.github.frontear.efkolia.api.configuration.IConfigurable Maven / Gradle / Ivy

Go to download

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

A simple framework designed for Minecraft modding

There is a newer version: 0.2.8

package com.github.frontear.efkolia.api.configuration;

import com.github.frontear.internal.NotNull;

/**
 * The interface given to all items that are to be internally modified via {@link IConfig}.
 *
 * @param  The value {@link IConfig#load()} will give to your object. You then set the state
 *            through {@link IConfigurable#load(IConfigurable)}.
 */
public interface IConfigurable> {
    /**
     * Loading information from the configuration file, and passing it to the {@link IConfigurable}
     * in order to allow it to extract the data it needs.
     *
     * @param value The information from the configuration file.
     */
    void load(@NotNull final E value);

    /**
     * This is used to identify what belongs to the object from the configuration file.
     *
     * @return The property name of the object.
     */
    @NotNull
    String getPropertyName();
}