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

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

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  DigitalInputConfig.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;

/**
 * DigitalInputConfig interface.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public interface DigitalInputConfig extends DigitalConfig {

    /** Constant PULL_RESISTANCE_KEY="pull" */
    String PULL_RESISTANCE_KEY = "pull";
    /** Constant DEBOUNCE_RESISTANCE_KEY="debounce" */
    String DEBOUNCE_RESISTANCE_KEY = "debounce";

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

    /**
     * debounce.
     *
     * @return a {@link java.lang.Long} object.
     */
    Long debounce();
    /**
     * getDebounce.
     *
     * @return a {@link java.lang.Long} object.
     */
    default Long getDebounce(){ return debounce(); }

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