path: root/src/main/java/org/bukkit/configuration/ConfigurationSection.java

package org.bukkit.configuration;

import java.util.Map;
import java.util.Set;
import java.util.List;
import org.bukkit.OfflinePlayer;
import org.bukkit.util.Vector;
import org.bukkit.inventory.ItemStack;

/**
 * Represents a section of a {@link Configuration}
 */
public interface ConfigurationSection {
    /**
     * Gets a set containing all keys in this section.
     * <p>
     * If deep is set to true, then this will contain all the keys within any child
     * {@link ConfigurationSection}s (and their children, etc). These will be in a
     * valid path notation for you to use.
     * <p>
     * If deep is set to false, then this will contain only the keys of any direct children,
     * and not their own children.
     *
     * @param deep Whether or not to get a deep list, as opposed to a shallow list.
     * @return Set of keys contained within this ConfigurationSection.
     */
    public Set<String> getKeys(boolean deep);

    /**
     * Gets a Map containing all keys and their values for this section.
     * <p>
     * If deep is set to true, then this will contain all the keys and values within
     * any child {@link ConfigurationSection}s (and their children, etc). These
     * keys will be in a valid path notation for you to use.
     * <p>
     * If deep is set to false, then this will contain only the keys and values of any
     * direct children, and not their own children.
     *
     * @param deep Whether or not to get a deep list, as opposed to a shallow list.
     * @return Map of keys and values of this section.
     */
    public Map<String, Object> getValues(boolean deep);

    /**
     * Checks if this {@link ConfigurationSection} contains the given path.
     * <p>
     * If the value for the requested path does not exist but a default value has
     * been specified, this will return true.
     *
     * @param path Path to check for existence.
     * @return True if this section contains the requested path, either via default or being set.
     * @throws IllegalArgumentException Thrown when path is null.
     */
    public boolean contains(String path);

    /**
     * Checks if this {@link ConfigurationSection} has a value set for the given path.
     * <p>
     * If the value for the requested path does not exist but a default value has
     * been specified, this will still return false.
     *
     * @param path Path to check for existence.
     * @return True if this section contains the requested path, regardless of having a default.
     * @throws IllegalArgumentException Thrown when path is null.
     */
    public boolean isSet(String path);

    /**
     * Gets the path of this {@link ConfigurationSection} from its root {@link Configuration}
     * <p>
     * For any {@link Configuration} themselves, this will return an empty string.
     * <p>
     * If the section is no longer contained within its root for any reason, such as
     * being replaced with a different value, this may return null.
     * <p>
     * To retrieve the single name of this section, that is, the final part of the path
     * returned by this method, you may use {@link #getName()}.
     *
     * @return Path of this section relative to its root
     */
    public String getCurrentPath();
    
    /**
     * Gets the name of this individual {@link ConfigurationSection}, in the path.
     * <p>
     * This will always be the final part of {@link #getCurrentPath()}, unless the
     * section is orphaned.
     * 
     * @return Name of this section
     */
    public String getName();

    /**
     * Gets the root {@link Configuration} that contains this {@link ConfigurationSection}
     * <p>
     * For any {@link Configuration} themselves, this will return its own object.
     * <p>
     * If the section is no longer contained within its root for any reason, such as
     * being replaced with a different value, this may return null.
     *
     * @return Root configuration containing this section.
     */
    public Configuration getRoot();

    /**
     * Gets the parent {@link ConfigurationSection} that directly contains this
     * {@link ConfigurationSection}.
     * <p>
     * For any {@link Configuration} themselves, this will return null.
     * <p>
     * If the section is no longer contained within its parent for any reason, such as
     * being replaced with a different value, this may return null.
     *
     * @return Parent section containing this section.
     */
    public ConfigurationSection getParent();

    /**
     * Gets the requested Object by path.
     * <p>
     * If the Object does not exist but a default value has been specified, this
     * will return the default value. If the Object does not exist and no default
     * value was specified, this will return null.
     *
     * @param path Path of the Object to get.
     * @return Requested Object.
     */
    public Object get(String path);

    /**
     * Gets the requested Object by path, returning a default value if not found.
     * <p>
     * If the Object does not exist then the specified default value will returned
     * regardless of if a default has been identified in the root {@link Configuration}.
     *
     * @param path Path of the Object to get.
     * @return Requested Object.
     */
    public Object get(String path, Object def);

    /**
     * Sets the specified path to the given value.
     * <p>
     * If value is null, the entry will be removed. Any existing entry will be
     * replaced, regardless of what the new value is.
     * <p>
     * Some implementations may have limitations on what you may store. See their
     * individual javadocs for details. No implementations should allow you to store
     * {@link Configuration}s or {@link ConfigurationSection}s, please use 
     * {@link #createSection(java.lang.String)} for that.
     *
     * @param path Path of the object to set.
     * @param value New value to set the path to.
     */
    public void set(String path, Object value);

    /**
     * Creates an empty {@link ConfigurationSection} at the specified path.
     * <p>
     * Any value that was previously set at this path will be overwritten. If the
     * previous value was itself a {@link ConfigurationSection}, it will be orphaned.
     *
     * @param path Path to create the section at.
     * @return Newly created section
     */
    public ConfigurationSection createSection(String path);

    // Primitives
    /**
     * Gets the requested String by path.
     * <p>
     * If the String does not exist but a default value has been specified, this
     * will return the default value. If the String does not exist and no default
     * value was specified, this will return null.
     *
     * @param path Path of the String to get.
     * @return Requested String.
     */
    public String getString(String path);

    /**
     * Gets the requested String by path, returning a default value if not found.
     * <p>
     * If the String does not exist then the specified default value will returned
     * regardless of if a default has been identified in the root {@link Configuration}.
     *
     * @param path Path of the String to get.
     * @return Requested String.
     */
    public String getString(String path, String def);

    /**
     * Checks if the specified path is a String.
     * <p>
     * If the path exists but is not a String, this will return false. If the path does not
     * exist, this will return false. If the path does not exist but a default value
     * has been specified, this will check if that default value is a String and return
     * appropriately.
     *
     * @param path Path of the String to check.
     * @return Whether or not the specified path is a String.
     */
    public boolean isString(String path);


    /**
     * Gets the requested int by path.
     * <p>
     * If the int does not exist but a default value has been specified, this
     * will return the default value. If the int does not exist and no default
     * value was specified, this will return null.
     *
     * @param path Path of the int to get.
     * @return Requested int.
     */
    public int getInt(String path);

    /**
     * Gets the requested int by path, returning a default value if not found.
     * <p>
     * If the int does not exist then the specified default value will returned
     * regardless of if a default has been identified in the root {@link Configuration}.
     *
     * @param path Path of the int to get.
     * @return Requested int.
     */
    public int getInt(String path, int def);

    /**
     * Checks if the specified path is an int.
     * <p>
     * If the path exists but is not a int, this will return false. If the path does not
     * exist, this will return false. If the path does not exist but a default value
     * has been specified, this will check if that default value is a int and return
     * appropriately.
     *
     * @param path Path of the int to check.
     * @return Whether or not the specified path is an int.
     */
    public boolean isInt(String path);


    /**
     * Gets the requested boolean by path.
     * <p>
     * If the boolean does not exist but a default value has been specified, this
     * will return the default value. If the boolean does not exist and no default
     * value was specified, this will return false.
     *
     * @param path Path of the boolean to get.
     * @return Requested boolean.
     */
    public boolean getBoolean(String path);

    /**
     * Gets the requested boolean by path, returning a default value if not found.
     * <p>
     * If the boolean does not exist then the specified default value will returned
     * regardless of if a default has been identified in the root {@link Configuration}.
     *
     * @param path Path of the boolean to get.
     * @return Requested boolean.
     */
    public boolean getBoolean(String path, boolean def);

    /**
     * Checks if the specified path is a boolean.
     * <p>
     * If the path exists but is not a boolean, this will return false. If the path does not
     * exist, this will return false. If the path does not exist but a default value
     * has been specified, this will check if that default value is a boolean and return
     * appropriately.
     *
     * @param path Path of the boolean to check.
     * @return Whether or not the specified path is a boolean.
     */
    public boolean isBoolean(String path);


    /**
     * Gets the requested double by path.
     * <p>
     * If the double does not exist but a default value has been specified, this
     * will return the default value. If the double does not exist and no default
     * value was specified, this will return null.
     *
     * @param path Path of the double to get.
     * @return Requested double.
     */
    public double getDouble(String path);

    /**
     * Gets the requested double by path, returning a default value if not found.
     * <p>
     * If the double does not exist then the specified default value will returned
     * regardless of if a default has been identified in the root {@link Configuration}.
     *
     * @param path Path of the double to get.
     * @return Requested double.
     */
    public double getDouble(String path, double def);

    /**
     * Checks if the specified path is a double.
     * <p>
     * If the path exists but is not a double, this will return false. If the path does not
     * exist, this will return false. If the path does not exist but a default value
     * has been specified, this will check if that default value is a double and return
     * appropriately.
     *
     * @param path Path of the double to check.
     * @return Whether or not the specified path is a double.
     */
    public boolean isDouble(String path);


    /**
     * Gets the requested long by path.
     * <p>
     * If the long does not exist but a default value has been specified, this
     * will return the default value. If the long does not exist and no default
     * value was specified, this will return null.
     *
     * @param path Path of the long to get.
     * @return Requested long.
     */
    public long getLong(String path);

    /**
     * Gets the requested long by path, returning a default value if not found.
     * <p>
     * If the long does not exist then the specified default value will returned
     * regardless of if a default has been identified in the root {@link Configuration}.
     *
     * @param path Path of the long to get.
     * @return Requested long.
     */
    public long getLong(String path, long def);

    /**
     * Checks if the specified path is a long.
     * <p>
     * If the path exists but is not a long, this will return false. If the path does not
     * exist, this will return false. If the path does not exist but a default value
     * has been specified, this will check if that default value is a long and return
     * appropriately.
     *
     * @param path Path of the long to check.
     * @return Whether or not the specified path is a long.
     */
    public boolean isLong(String path);



    // Java
    /**
     * Gets the requested List by path.
     * <p>
     * If the List does not exist but a default value has been specified, this
     * will return the default value. If the List does not exist and no default
     * value was specified, this will return null.
     *
     * @param path Path of the List to get.
     * @return Requested List.
     */
    public List getList(String path);

    /**
     * Gets the requested List by path, returning a default value if not found.
     * <p>
     * If the List does not exist then the specified default value will returned
     * regardless of if a default has been identified in the root {@link Configuration}.
     *
     * @param path Path of the List to get.
     * @return Requested List.
     */
    public List getList(String path, List def);

    /**
     * Checks if the specified path is a List.
     * <p>
     * If the path exists but is not a List, this will return false. If the path does not
     * exist, this will return false. If the path does not exist but a default value
     * has been specified, this will check if that default value is a List and return
     * appropriately.
     *
     * @param path Path of the List to check.
     * @return Whether or not the specified path is a List.
     */
    public boolean isList(String path);



    // Bukkit
    /**
     * Gets the requested Vector by path.
     * <p>
     * If the Vector does not exist but a default value has been specified, this
     * will return the default value. If the Vector does not exist and no default
     * value was specified, this will return null.
     *
     * @param path Path of the Vector to get.
     * @return Requested Vector.
     */
    public Vector getVector(String path);

    /**
     * Gets the requested Vector by path, returning a default value if not found.
     * <p>
     * If the Vector does not exist then the specified default value will returned
     * regardless of if a default has been identified in the root {@link Configuration}.
     *
     * @param path Path of the Vector to get.
     * @return Requested Vector.
     */
    public Vector getVector(String path, Vector def);

    /**
     * Checks if the specified path is a Vector.
     * <p>
     * If the path exists but is not a Vector, this will return false. If the path does not
     * exist, this will return false. If the path does not exist but a default value
     * has been specified, this will check if that default value is a Vector and return
     * appropriately.
     *
     * @param path Path of the Vector to check.
     * @return Whether or not the specified path is a Vector.
     */
    public boolean isVector(String path);


    /**
     * Gets the requested OfflinePlayer by path.
     * <p>
     * If the OfflinePlayer does not exist but a default value has been specified, this
     * will return the default value. If the OfflinePlayer does not exist and no default
     * value was specified, this will return null.
     *
     * @param path Path of the OfflinePlayer to get.
     * @return Requested OfflinePlayer.
     */
    public OfflinePlayer getOfflinePlayer(String path);

    /**
     * Gets the requested OfflinePlayer by path, returning a default value if not found.
     * <p>
     * If the OfflinePlayer does not exist then the specified default value will returned
     * regardless of if a default has been identified in the root {@link Configuration}.
     *
     * @param path Path of the OfflinePlayer to get.
     * @return Requested OfflinePlayer.
     */
    public OfflinePlayer getOfflinePlayer(String path, OfflinePlayer def);

    /**
     * Checks if the specified path is an OfflinePlayer.
     * <p>
     * If the path exists but is not a OfflinePlayer, this will return false. If the path does not
     * exist, this will return false. If the path does not exist but a default value
     * has been specified, this will check if that default value is a OfflinePlayer and return
     * appropriately.
     *
     * @param path Path of the OfflinePlayer to check.
     * @return Whether or not the specified path is an OfflinePlayer.
     */
    public boolean isOfflinePlayer(String path);


    /**
     * Gets the requested ItemStack by path.
     * <p>
     * If the ItemStack does not exist but a default value has been specified, this
     * will return the default value. If the ItemStack does not exist and no default
     * value was specified, this will return null.
     *
     * @param path Path of the ItemStack to get.
     * @return Requested ItemStack.
     */
    public ItemStack getItemStack(String path);

    /**
     * Gets the requested ItemStack by path, returning a default value if not found.
     * <p>
     * If the ItemStack does not exist then the specified default value will returned
     * regardless of if a default has been identified in the root {@link Configuration}.
     *
     * @param path Path of the ItemStack to get.
     * @return Requested ItemStack.
     */
    public ItemStack getItemStack(String path, ItemStack def);

    /**
     * Checks if the specified path is an ItemStack.
     * <p>
     * If the path exists but is not a ItemStack, this will return false. If the path does not
     * exist, this will return false. If the path does not exist but a default value
     * has been specified, this will check if that default value is a ItemStack and return
     * appropriately.
     *
     * @param path Path of the ItemStack to check.
     * @return Whether or not the specified path is an ItemStack.
     */
    public boolean isItemStack(String path);


    /**
     * Gets the requested ConfigurationSection by path.
     * <p>
     * If the ConfigurationSection does not exist but a default value has been specified, this
     * will return the default value. If the ConfigurationSection does not exist and no default
     * value was specified, this will return null.
     *
     * @param path Path of the ConfigurationSection to get.
     * @return Requested ConfigurationSection.
     */
    public ConfigurationSection getConfigurationSection(String path);

    /**
     * Checks if the specified path is a ConfigurationSection.
     * <p>
     * If the path exists but is not a ConfigurationSection, this will return false. If the path does not
     * exist, this will return false. If the path does not exist but a default value
     * has been specified, this will check if that default value is a ConfigurationSection and return
     * appropriately.
     *
     * @param path Path of the ConfigurationSection to check.
     * @return Whether or not the specified path is a ConfigurationSection.
     */
    public boolean isConfigurationSection(String path);
    
    /**
     * Gets the equivalent {@link ConfigurationSection} from the default {@link Configuration} defined in {@link #getRoot()}.
     * <p>
     * If the root contains no defaults, or the defaults doesn't contain a value
     * for this path, or the value at this path is not a {@link ConfigurationSection} then
     * this will return null.
     * 
     * @return Equivalent section in root configuration
     */
    public ConfigurationSection getDefaultSection();
    
    /**
     * Sets the default value in the root at the given path as provided.
     * <p>
     * If no source {@link Configuration} was provided as a default collection,
     * then a new {@link MemoryConfiguration} will be created to hold the new default
     * value.
     * <p>
     * If value is null, the value will be removed from the default Configuration source.
     * <p>
     * If the value as returned by {@link #getDefaultSection()} is null,
     * then this will create a new section at the path, replacing anything that
     * may have existed there previously.
     *
     * @param path Path of the value to set.
     * @param value Value to set the default to.
     * @throws IllegalArgumentException Thrown if path is null.
     */
    public void addDefault(String path, Object value);
}