com.pi4j.config.impl.DeviceConfigBase 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.impl;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  DeviceConfigBase.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 com.pi4j.config.Config;
import com.pi4j.config.ConfigBase;
import com.pi4j.config.DeviceConfig;
import com.pi4j.config.exception.ConfigMissingRequiredKeyException;

import java.util.Map;

/**
 * Abstract DeviceConfigBase class.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public abstract class DeviceConfigBase>
        extends ConfigBase
        implements DeviceConfig {

    // private configuration variables
    protected String device =  null;

    /**
     * PRIVATE CONSTRUCTOR
     */
    protected DeviceConfigBase(){
    }

    /**
     * PRIVATE CONSTRUCTOR
     *
     * @param properties a {@link java.util.Map} object.
     */
    protected DeviceConfigBase(Map properties){
        super(properties);

        // load address property
        if(properties.containsKey(DEVICE_KEY)){
            this.device = properties.get(DEVICE_KEY);
        } else {
            throw new ConfigMissingRequiredKeyException(DEVICE_KEY);
        }
    }

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