com.pi4j.plugin.mock.provider.gpio.digital.MockDigitalInput Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pi4j-plugin-mock Show documentation

Pi4J Library Plugin for the Mock I/O Platform & Providers

The newest version!

package com.pi4j.plugin.mock.provider.gpio.digital;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: PLUGIN   :: Mock Platform & Providers
 * FILENAME      :  MockDigitalInput.java
 *
 * This file is part of the Pi4J project. More information about
 * this project can be found here:  https://pi4j.com/
 * **********************************************************************
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 *
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */


import com.pi4j.io.gpio.digital.*;

/**
 * MockDigitalInput class.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public class MockDigitalInput extends DigitalInputBase implements DigitalInput {

    private DigitalState state = DigitalState.LOW;

    /**
     * Constructor for MockDigitalInput.
     *
     * @param provider a {@link com.pi4j.io.gpio.digital.DigitalInputProvider} object.
     * @param config a {@link com.pi4j.io.gpio.digital.DigitalInputConfig} object.
     */
    public MockDigitalInput(DigitalInputProvider provider, DigitalInputConfig config){
        super(provider, config);
    }

    /** {@inheritDoc} */
    @Override
    public DigitalState state() {
        return this.state;
    }

    /**
     * mockState.
     *
     * @param state a {@link com.pi4j.io.gpio.digital.DigitalState} object.
     * @return a {@link com.pi4j.plugin.mock.provider.gpio.digital.MockDigitalInput} object.
     */
    public MockDigitalInput mockState(DigitalState state){
        if(!this.state.equals(state)) {
            this.state = state;
            this.dispatch(new DigitalStateChangeEvent(this, this.state));
        }
        return this;
    }
}