001/*
002 * JGrapes Event Driven Framework
003 * Copyright (C) 2023 Michael N. Lipp
004 * 
005 * This program is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU Affero General Public License as published by 
007 * the Free Software Foundation; either version 3 of the License, or 
008 * (at your option) any later version.
009 * 
010 * This program is distributed in the hope that it will be useful, but 
011 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
012 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License 
013 * for more details.
014 * 
015 * You should have received a copy of the GNU Affero General Public License along 
016 * with this program; if not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jgrapes.util.events;
020
021import java.nio.file.Path;
022import org.jgrapes.core.Event;
023import org.jgrapes.util.FileSystemWatcher;
024
025/**
026 * Registers a path to be watched with a {@link FileSystemWatcher}.
027 */
028public class WatchFile extends Event<Void> {
029
030    private final Path path;
031
032    /**
033     * Creates a new instance.
034     *
035     * @param path the file's path
036     */
037    public WatchFile(Path path) {
038        this.path = path;
039    }
040
041    /**
042     * Return's the event's path. 
043     * 
044     * @return the path
045     */
046    public Path path() {
047        return path;
048    }
049}