• Home
• net.sourceforge.web-harvest
• webharvest-core
• 2.1.0-RC1
• source code
• Config.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.webharvest.definition.Config Maven / Gradle / Ivy

package org.webharvest.definition;

/**
 * Represents lazily loaded configuration object that is loaded from associated
 * {@link ConfigSource} on demand with call to {@link #reload()} method. For
 * already loaded configuration it is possible to get reference to a graph of
 * configuration elements with {@link #getElementDef}.
 *
 * @author Robert Bala
 * @since 2.1.0-SNAPSHOT
 * @version %I%, %G%
 * @see ConfigSource
 * @see IElementDef
 */
public interface Config {

    /**
     * Gets reference to configuration resource {@link ConfigSource}.
     *
     * @return configuration resource that is meant to contain configuration.
     */
    ConfigSource getConfigSource();

    /**
     * Gets reference to configuration root element.
     *
     * @return for loaded configuration gets root element, throws
     *         {@link IllegalStateException} in case the configuration has not
     *         been loaded.
     */
    IElementDef getElementDef();

    /**
     * Gets reference to configuration root element namespace
     *
     * @deprecated Provided as a backward compatibility with older version
     * @return namespace URL or {@link IllegalStateException} in case the
     *         configuration has not been loaded.
     */
    @Deprecated
    String getNamespaceURI();

    /**
     * Loads configuration from resource defined by {@link #getConfigSource()}.
     * Once the configuration is successfully loaded it is possible to get
     * reference to root configuration element with {@link #getElementDef()}.
     */
    void reload();

}