src/api/java/mcp/mobius/waila/api/IWailaConfigHandler.java

package mcp.mobius.waila.api;

import java.util.HashMap;
import java.util.Set;

/**
 * Read-only interface for Waila internal config storage.<br>
 * An instance of this interface is passed to most of Waila callbacks as a way to change the behavior depending on client settings.
 * 
 * @author ProfMobius
 *
 */
public interface IWailaConfigHandler {
	/** Returns a set of all the currently loaded modules in the config handler.
	 * 
	 * @return
	 */
	public Set<String> getModuleNames();
	
	/**
	 * Returns all the currently available options for a given module
	 * 
	 * @param modName Module name
	 * @return
	 */
	public HashMap<String, String> getConfigKeys(String modName);
	
	/**
	 * Returns the current value of an option (true/false) with a default value if not set.
	 * 
	 * @param key Option to lookup
	 * @param defvalue Default values
	 * @return Value of the option or defvalue if not set.
	 */
	public boolean getConfig(String key, boolean defvalue);
	
	/**
	 * Returns the current value of an option (true/false) with a default value true if not set
	 * 
	 * @param key Option to lookup
	 * @return Value of the option or true if not set.
	 */
	public boolean getConfig(String key);	
}