001package com.pi4j.io.gpio.event;
002
003/*
004 * #%L
005 * **********************************************************************
006 * ORGANIZATION  :  Pi4J
007 * PROJECT       :  Pi4J :: Java Library (Core)
008 * FILENAME      :  PinEvent.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 - 2021 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
033import java.util.EventObject;
034
035import com.pi4j.io.gpio.Pin;
036
037
038/**
039 * GPIO pin event.
040 *
041 * @author Robert Savage (<a
042 *         href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
043 */
044public class PinEvent extends EventObject {
045
046    private static final long serialVersionUID = 5238592505805435621L;
047    protected final Pin pin;
048    protected final PinEventType type;
049
050    /**
051     * Default event constructor
052     *
053     * @param obj Ignore this parameter
054     * @param pin GPIO pin number (not header pin number; not wiringPi pin number)
055     */
056    public PinEvent(Object obj, Pin pin, PinEventType type) {
057        super(obj);
058        this.pin = pin;
059        this.type = type;
060    }
061
062    /**
063     * Get the pin number that changed and raised this event.
064     *
065     * @return GPIO pin number (not header pin number; not wiringPi pin number)
066     */
067    public Pin getPin() {
068        return pin;
069    }
070
071    public PinEventType getEventType() {
072        return type;
073    }
074}