001package com.pi4j.io.serial;
002
003/*
004 * #%L
005 * **********************************************************************
006 * ORGANIZATION  :  Pi4J
007 * PROJECT       :  Pi4J :: Java Library (Core)
008 * FILENAME      :  SerialDataEvent.java  
009 * 
010 * This file is part of the Pi4J project. More information about 
011 * this project can be found here:  http://www.pi4j.com/
012 * **********************************************************************
013 * %%
014 * Copyright (C) 2012 - 2015 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 serial data event object.</p>
037 * 
038 * <p>
039 * Before using the Pi4J library, you need to ensure that the Java VM in configured with access to
040 * the following system libraries:
041 * <ul>
042 * <li>pi4j</li>
043 * <li>wiringPi</li>
044 * </ul>
045 * <blockquote> This library depends on the wiringPi native system library.</br> (developed by
046 * Gordon Henderson @ <a href="http://wiringpi.com/">http://wiringpi.com/</a>)
047 * </blockquote>
048 * </p>
049 * 
050 * @see com.pi4j.io.serial.Serial
051 * @see com.pi4j.io.serial.SerialDataListener
052 * @see com.pi4j.io.serial.SerialFactory
053 * 
054 * @see <a href="http://www.pi4j.com/">http://www.pi4j.com/</a>
055 * @author Robert Savage (<a
056 *         href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
057 */
058public class SerialDataEvent extends EventObject {
059
060    private static final long serialVersionUID = 1L;
061    private final String data;
062
063    /**
064     * Default event constructor.
065     * 
066     * @param obj The com.pi4j.io.serial.Serial class instance that initiates this event.
067     * @param data The data received.
068     */
069    public SerialDataEvent(Object obj, String data) {
070        super(obj);
071        this.data = data;
072    }
073
074    /**
075     * Get the data string received.
076     * 
077     * @return The data string received.
078     */
079    public String getData() {
080        return data;
081    }
082}