com.pi4j.io.gpio.digital.Digital 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.io.gpio.digital;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  Digital.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.io.OnOffRead;
import com.pi4j.io.binding.Bindable;
import com.pi4j.io.binding.DigitalBinding;
import com.pi4j.io.gpio.Gpio;

/**
 * Digital interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface Digital,
        CONFIG_TYPE extends DigitalConfig,
        PROVIDER_TYPE extends DigitalProvider>
        extends Gpio,
        OnOffRead,
        Bindable
{

    /**
     * state.
     *
     * @return a {@link com.pi4j.io.gpio.digital.DigitalState} object.
     */
    DigitalState state();

    /**
     * addListener.
     *
     * @param listener a {@link DigitalStateChangeListener} object.
     * @return a DIGITAL_TYPE object.
     */
    DIGITAL_TYPE addListener(DigitalStateChangeListener... listener);
    /**
     * removeListener.
     *
     * @param listener a {@link DigitalStateChangeListener} object.
     * @return a DIGITAL_TYPE object.
     */
    DIGITAL_TYPE removeListener(DigitalStateChangeListener... listener);

    /**
     * equals.
     *
     * @param state a {@link com.pi4j.io.gpio.digital.DigitalState} object.
     * @return a boolean.
     */
    default boolean equals(DigitalState state){
        return this.state().equals(state);
    }
    /**
     * equals.
     *
     * @param state a {@link java.lang.Number} object.
     * @return a boolean.
     */
    default boolean equals(Number state){
        return equals(DigitalState.getState(state));
    }
    /**
     * equals.
     *
     * @param state a boolean.
     * @return a boolean.
     */
    default boolean equals(boolean state){
        return equals(DigitalState.getState(state));
    }
    /**
     * equals.
     *
     * @param state a byte.
     * @return a boolean.
     */
    default boolean equals(byte state){
        return equals(DigitalState.getState(state));
    }
    /**
     * equals.
     *
     * @param state a short.
     * @return a boolean.
     */
    default boolean equals(short state){
        return equals(DigitalState.getState(state));
    }
    /**
     * equals.
     *
     * @param state a int.
     * @return a boolean.
     */
    default boolean equals(int state){
        return equals(DigitalState.getState(state));
    }
    /**
     * equals.
     *
     * @param state a long.
     * @return a boolean.
     */
    default boolean equals(long state){
        return equals(DigitalState.getState(state));
    }
    /**
     * equals.
     *
     * @param state a float.
     * @return a boolean.
     */
    default boolean equals(float state){
        return equals(DigitalState.getState(state));
    }
    /**
     * equals.
     *
     * @param state a double.
     * @return a boolean.
     */
    default boolean equals(double state){
        return equals(DigitalState.getState(state));
    }
    /**
     * isHigh.
     *
     * @return a boolean.
     */
    default boolean isHigh(){
        return this.state().isHigh();
    }
    /**
     * isLow.
     *
     * @return a boolean.
     */
    default boolean isLow(){
        return this.state().isLow();
    }
}