com.pi4j.io.gpio.digital.DigitalInput Maven / Gradle / Ivy

Go to download
package com.pi4j.io.gpio.digital;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  DigitalInput.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.context.Context;
import com.pi4j.io.Input;

/**
 * DigitalInput interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface DigitalInput extends Digital, Input {
    /** Constant DEFAULT_DEBOUNCE=10000 */
    long DEFAULT_DEBOUNCE = 10000;

    /**
     * newConfigBuilder.
     *
     * @param context {@link Context}
     * @return a {@link com.pi4j.io.gpio.digital.DigitalInputConfigBuilder} object.
     */
    static DigitalInputConfigBuilder newConfigBuilder(Context context){
        return DigitalInputConfigBuilder.newInstance(context);
    }

    /**
     * pull.
     *
     * @return a {@link com.pi4j.io.gpio.digital.PullResistance} object.
     */
    default PullResistance pull() { return config().pull(); }
}