001/*
002 * JGrapes Event Driven Framework
003 * Copyright (C) 2022 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.io.events;
020
021import java.nio.file.OpenOption;
022import java.nio.file.Path;
023import java.util.Arrays;
024import org.jgrapes.core.Event;
025
026/**
027 * A base class for events that cause a file to be opened.
028 */
029public class OpenFile extends Event<Void> {
030
031    private final Path path;
032    private final OpenOption[] options;
033
034    /**
035     * Creates a new instance.
036     * 
037     * @param path the file's path
038     * @param options open options
039     */
040    public OpenFile(Path path, OpenOption... options) {
041        this.path = path;
042        this.options = Arrays.copyOf(options, options.length);
043    }
044
045    /**
046     * Return's the event's path. 
047     * 
048     * @return the path
049     */
050    public Path path() {
051        return path;
052    }
053
054    /**
055     * Returns the event's options.
056     * 
057     * @return the options
058     */
059    public OpenOption[] options() {
060        return Arrays.copyOf(options, options.length);
061    }
062}