001package com.pi4j.jni; 002 003/* 004 * #%L 005 * ********************************************************************** 006 * ORGANIZATION : Pi4J 007 * PROJECT : Pi4J :: Java Library (Core) 008 * FILENAME : SerialInterruptEvent.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 033import java.util.EventObject; 034 035/** 036 * <p> This class provides the event object for Serial interrupt data receive event. </p> 037 * 038 * @see <a href="https://www.pi4j.com/">https://www.pi4j.com/</a> 039 * @author Robert Savage (<a 040 * href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>) 041 */ 042public class SerialInterruptEvent extends EventObject { 043 044 private static final long serialVersionUID = 1L; 045 private int fileDescriptor; 046 private byte[] data; 047 048 /** 049 * <h1>Default event constructor</h1> 050 * 051 * @param obj Ignore this parameter 052 * @param fileDescriptor The serial file handle/descriptor in use 053 * @param data data bytes received in this event from the serial receive buffer 054 */ 055 public SerialInterruptEvent(Object obj, int fileDescriptor, byte[] data) { 056 super(obj); 057 this.fileDescriptor = fileDescriptor; 058 this.data = data; 059 } 060 061 /** 062 * Get the serial port file descriptor/handle 063 * 064 * @return serial port file descriptor/handle 065 */ 066 public int getFileDescriptor() { 067 return fileDescriptor; 068 } 069 070 /** 071 * Get the length of data bytes received in this event. 072 * 073 * @return length of data bytes received in this event 074 */ 075 public int getLength() { 076 return data.length; 077 } 078 079 /** 080 * Get the data bytes received in this event. 081 * 082 * @return data bytes received in this event 083 */ 084 public byte[] getData() { 085 return data; 086 } 087 088}