// This Source Code is in the Public Domain per: http://unlicense.org
package org.litesoft.configuration;

public interface ConfigDataAccessor extends ConfigDataAccessorFactory
{
    public enum Level
    {
        RUN, USER, MACHINE
    }

    /**
     * @return !null
     */
    public String[] getAllKeys();

    /**
     * @param pKey not null or empty
     *
     * @return null if not found or value associated with key
     */
    public String getString( String pKey );

    /**
     * @return !null - source of Config data.
     */
    public String loadedFrom();

    /**
     * @return null if from ResourceAsStream or full directory path where relative config file path was loaded from.
     */
    public String loadedFromDirectory();

    /**
     * All implementations MUST support RUN level, but may not support other levels
     *
     * @return an array with at least 1 (RUN) entry
     */
    public Level[] getSetableSupportedLevels();

    /**
     * All implementations MUST support RUN level, but may not support other levels
     *
     * @param pLevel null interpreted as RUN
     * @param pKey   not null or empty
     * @param pValue null means remove
     *
     * @throws UnsupportedOperationException if requested level not supported
     */
    public void setKeyValue( Level pLevel, String pKey, String pValue )
            throws UnsupportedOperationException;

    /**
     * Override (set at the Run Level) all values who's key starts with the pKeyPrefix
     *
     * @param pKeyPrefix !null & !empty
     * @param pValue     !null
     */
    public void overrideAllStartingWith( String pKeyPrefix, String pValue );
}