org.jnosql.artemis.configuration.Configurable Maven / Gradle / Ivy

Go to download
/*
 *  Copyright (c) 2017 Otávio Santana and others
 *   All rights reserved. This program and the accompanying materials
 *   are made available under the terms of the Eclipse Public License v1.0
 *   and Apache License v2.0 which accompanies this distribution.
 *   The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 *   and the Apache License v2.0 is available at http://www.opensource.org/licenses/apache2.0.php.
 *
 *   You may elect to redistribute this code under either of these licenses.
 *
 *   Contributors:
 *
 *   Otavio Santana
 */
package org.jnosql.artemis.configuration;

import java.io.Serializable;
import java.util.Map;

/**
 * This class is the information unit that returns from a file
 */
public interface Configurable extends Serializable {


    /**
     * Get the unit-name
     *
     * @return the name
     */
    String getName();


    /**
     * Get the description
     *
     * @return the description
     */
    String getDescription();

    /**
     * Get the provider
     *
     * @return provider
     */
    String getProvider();

    /**
     * the settings map
     *
     * @return the settings map
     */
    Map getSettings();
}