Package org.jgrapes.io.events

Class FileOpened

java.lang.Object

org.jgrapes.core.internal.EventBase<OpenFile>

org.jgrapes.core.Event<OpenFile>

org.jgrapes.io.events.Opened<OpenFile>

org.jgrapes.io.events.FileOpened

All Implemented Interfaces:

Future<OpenFile>, Associator, Eligible

public class FileOpened
extends Opened<OpenFile>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Field Summary

Fields inherited from class org.jgrapes.core.internal.EventBase

completed, completionEvents, invokedFor

Constructor Summary

Constructors

Constructor	Description
FileOpened(OpenFile event)	Instantiates a new event, using the values for path and options from the opening event.
FileOpened(OpenFile event, Path path, OpenOption... options)	Instantiates a new event, overriding the values using the given values for path and options.

Method Summary

Modifier and Type	Method	Description
OpenFile	openEvent()	Returns the event that caused the file to be opened.
OpenOption[]	options()
Path	path()

Methods inherited from class org.jgrapes.core.Event

addCompletionEvent, associated, cancel, channels, channels, completionEvents, currentResults, defaultCriterion, forChannels, get, get, handled, handlingError, isCancelled, isDone, isEligibleFor, isStopped, processedBy, results, results, resumeHandling, setAssociated, setChannels, setRequiresResult, setResult, stop, suspendHandling, suspendHandling, tieTo, toString

Methods inherited from class org.jgrapes.core.internal.EventBase

disableTracking, enqueued, firstResultAssigned, isTracked, onCompletion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jgrapes.core.Associator

associated, associated, associated, associatedGet

Methods inherited from interface java.util.concurrent.Future

exceptionNow, resultNow, state

Constructor Details

FileOpened

public FileOpened(OpenFile event)

Instantiates a new event, using the values for path and options from the opening event.

Parameters:

event - the event that caused opening the file

FileOpened

public FileOpened(OpenFile event,
 Path path,
 OpenOption... options)

Instantiates a new event, overriding the values using the given values for path and options.

Parameters:

event - the event that caused opening the file

path - the path

options - the options

Method Details

openEvent

public OpenFile openEvent()

Returns the event that caused the file to be opened.

Returns:

the event

path

public Path path()

Returns:

the path

options

public OpenOption[] options()

Returns:

the options