001/*
002 * JGrapes Event Driven Framework
003 * Copyright (C) 2016-2018 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;
024
025import org.jgrapes.core.Event;
026
027/**
028 * Causes the content of a file to be streamed as a sequence of {@link Output}
029 * events (terminated by an event with the end of record flag set) on the 
030 * channel that this event is fired on.
031 */
032public class StreamFile extends Event<Void> {
033
034    private final Path path;
035    private final OpenOption[] options;
036
037    /**
038     * Creates a new instance.
039     * 
040     * @param path the file's path
041     * @param options open options
042     */
043    public StreamFile(Path path, OpenOption... options) {
044        this.path = path;
045        this.options = Arrays.copyOf(options, options.length);
046    }
047
048    /**
049     * Returns the event's path.
050     * 
051     * @return the path
052     */
053    public Path path() {
054        return path;
055    }
056
057    /**
058     * Returns the event's options.
059     * 
060     * @return the options
061     */
062    public OpenOption[] options() {
063        return Arrays.copyOf(options, options.length);
064    }
065
066}