com.pi4j.config.Config Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pi4j-core Show documentation
Pi4J Java API & Runtime Library
The newest version!
package com.pi4j.config;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  Config.java
 *
 * This file is part of the Pi4J project. More information about
 * this project can be found here:  https://pi4j.com/
 * **********************************************************************
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import java.util.Map;

/**
 * Config interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface Config {
    /** Constant ID_KEY="id" */
    String ID_KEY = "id";
    /** Constant NAME_KEY="name" */
    String NAME_KEY = "name";
    /** Constant DESCRIPTION_KEY="description" */
    String DESCRIPTION_KEY = "description";

    /**
     * Underlying raw configuration properties.
     * @return a {@link Map} of {@link String},{@link String} of raw property keys and string values.
     */
    Map properties();

    /**
     * id.
     *
     * @return a {@link java.lang.String} object.
     */
    String id();

    /**
     * name.
     *
     * @return a {@link java.lang.String} object.
     */
    String name();

    /**
     * description.
     *
     * @return a {@link java.lang.String} object.
     */
    String description();

    /**
     * validate.
     */
    void validate();

    /**
     * getId.
     *
     * @return a {@link java.lang.String} object.
     */
    default String getId(){
        return this.id();
    }
    /**
     * getName.
     *
     * @return a {@link java.lang.String} object.
     */
    default String getName(){
        return this.name();
    }
    /**
     * getDescription.
     *
     * @return a {@link java.lang.String} object.
     */
    default String getDescription(){
        return this.description();
    }
}