com.pi4j.library.pigpio.PiGpioState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pi4j-library-pigpio Show documentation

Pi4J wrapper for the PIGPIO library

There is a newer version: 2.7.0

package com.pi4j.library.pigpio;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: JNI Wrapper for PIGPIO Library
 * FILENAME      :  PiGpioState.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%
 */

/**
 * PiGpioState class.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public enum PiGpioState {
    UNKNOWN(-1),
    LOW  (0),
    HIGH (1);

    private int value;

    PiGpioState(int value){
        this.value  =value;
    }

    /**
     * value.
     *
     * @return a int.
     */
    public int value(){
        return this.value;
    }

    /**
     * from.
     *
     * @param value a {@link java.lang.Number} object.
     * @return a {@link com.pi4j.library.pigpio.PiGpioState} object.
     */
    public static PiGpioState from(Number value){
        for(PiGpioState c : PiGpioState.values()){
            if(c.value() == value.intValue()) return c;
        }
        return UNKNOWN;
    }

    /**
     * from.
     *
     * @param value a boolean.
     * @return a {@link com.pi4j.library.pigpio.PiGpioState} object.
     */
    public static PiGpioState from(boolean value){
        if(value == true) return PiGpioState.HIGH;
        return PiGpioState.LOW;
    }
}