001package com.pi4j.io.gpio; 002 003/* 004 * #%L 005 * ********************************************************************** 006 * ORGANIZATION : Pi4J 007 * PROJECT : Pi4J :: Java Library (Core) 008 * FILENAME : GpioPinDigitalInput.java 009 * 010 * This file is part of the Pi4J project. More information about 011 * this project can be found here: https://www.pi4j.com/ 012 * ********************************************************************** 013 * %% 014 * Copyright (C) 2012 - 2019 Pi4J 015 * %% 016 * This program is free software: you can redistribute it and/or modify 017 * it under the terms of the GNU Lesser General Public License as 018 * published by the Free Software Foundation, either version 3 of the 019 * License, or (at your option) any later version. 020 * 021 * This program is distributed in the hope that it will be useful, 022 * but WITHOUT ANY WARRANTY; without even the implied warranty of 023 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 024 * GNU General Lesser Public License for more details. 025 * 026 * You should have received a copy of the GNU General Lesser Public 027 * License along with this program. If not, see 028 * <http://www.gnu.org/licenses/lgpl-3.0.html>. 029 * #L% 030 */ 031 032/** 033 * This is a decorator interface to describe digital input pin. 034 * 035 * @author Robert Savage (<a 036 * href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>) 037 */ 038@SuppressWarnings("unused") 039public interface GpioPinDigitalInput extends GpioPinDigital, GpioPinInput { 040 041 /** 042 * Determines if a debounce delay interval has been configured for the given pin state. 043 * 044 * @param state the pin state to test for debounce delay. 045 * @return 'true' if the specified ping state has been configured with a debounce delay; else return 'false'. 046 */ 047 boolean hasDebounce(PinState state); 048 049 /** 050 * Gets the configured debounce delay interval (in milliseconds) for the given pin state. 051 * 052 * @param state the pin state to get the configured debounce delay interval. 053 * @return the debounce delay interval (in milliseconds) for the specified pin state. 054 */ 055 int getDebounce(PinState state); 056 057 /** 058 * Sets the debounce delay interval (in milliseconds) for all pin states. 059 * 060 * @param debounce The debounce delay interval in milliseconds. 061 */ 062 void setDebounce(int debounce); 063 064 /** 065 * Sets the debounce delay interval (in milliseconds) for the specified pin state. 066 * 067 * @param debounce The debounce delay interval in milliseconds. 068 * @param state The pin states to apply the debounce delay interval to. 069 */ 070 void setDebounce(int debounce, PinState ... state); 071}