de.aristaflow.adept2.core.eventmanager.fileevents

Class FileEventImpl

java.lang.Object

de.aristaflow.adept2.core.eventmanager.common.AbstractEvent

de.aristaflow.adept2.core.eventmanager.fileevents.FileEventImpl

All Implemented Interfaces:

Event, FileEvent

Direct Known Subclasses:

LockFileEventImpl

public class FileEventImpl
extends AbstractEvent
implements FileEvent

An event for files, that is, an event is produced and sent as soon as a file (or a directory) is created or stored in a specific folder.
This event source terminates as soon as an event has been handled. However, since it polls, one has to ensure that a handled file is deleted or moved to another folder. Otherwise the source will create another event for the file.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.file.attribute.BasicFileAttributes	attributes The file attributes of the path.
protected java.io.File	file Deprecated.
protected java.nio.file.Path	path The path for which the event has been created.
protected java.net.URL	url Deprecated.

Fields inherited from class de.aristaflow.adept2.core.eventmanager.common.AbstractEvent

creationTime, eventType, id, ID_COUNT, managerURI, sourceID, sourceType

Constructor Summary

Constructors

Constructor and Description
FileEventImpl(java.net.URI[] managerURI, java.lang.String eventType, java.lang.String sourceType, java.lang.String sourceID, java.io.File file) Deprecated. Use FileEventImpl(URI[], String, String, String, Path) instead.
FileEventImpl(java.net.URI[] managerURI, java.lang.String eventType, java.lang.String sourceType, java.lang.String sourceID, java.nio.file.Path path) Creates a new event for the designated path.

Method Summary

Modifier and Type	Method and Description
java.net.URI	getAsURI() Gets the URI of the file that caused this event.
java.net.URL	getAsURL() Gets the URL of the file that caused this event.
java.io.File	getFile() Gets the file that caused this event.
java.nio.file.attribute.BasicFileAttributes	getFileAttributes() Gets the basic file attributes of the path of this event.
java.util.Date	getLastModified() Gets the date the file that caused this event has been modified.
java.lang.String	getName() Gets the name of the file that caused this event.
java.nio.file.Path	getPath() Gets the path that caused this event.

Methods inherited from class de.aristaflow.adept2.core.eventmanager.common.AbstractEvent

getCreationTime, getEventManager, getEventType, getID, getSourceID, getSourceType

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.aristaflow.adept2.model.events.Event

getCreationTime, getEventManager, getEventType, getID, getSourceID, getSourceType

Field Detail

path

protected final java.nio.file.Path path

The path for which the event has been created.

attributes

protected final java.nio.file.attribute.BasicFileAttributes attributes

The file attributes of the path.

file

@Deprecated
protected final java.io.File file

Deprecated.

The file for which the event has been created.

url

@Deprecated
protected final java.net.URL url

Deprecated.

The URL of the file for which the event has been created.

Constructor Detail

FileEventImpl

@Deprecated
public FileEventImpl(java.net.URI[] managerURI,
                                 java.lang.String eventType,
                                 java.lang.String sourceType,
                                 java.lang.String sourceID,
                                 java.io.File file)
                          throws java.io.IOException

Deprecated. Use FileEventImpl(URI[], String, String, String, Path) instead.

Creates a new event for the designated file.

Parameters:

managerURI - The URIs of the service (event manager) creating the event.

eventType - The type of the event.

sourceType - The type of the source of this event.

sourceID - The ID of the source of this event.

file - The file of the event.

Throws:

java.io.IOException - Retrieving the URL of the file may throw an IOException.

FileEventImpl

public FileEventImpl(java.net.URI[] managerURI,
                     java.lang.String eventType,
                     java.lang.String sourceType,
                     java.lang.String sourceID,
                     java.nio.file.Path path)
              throws java.io.IOException

Creates a new event for the designated path.

Parameters:

managerURI - The URIs of the service (event manager) creating the event.

eventType - The type of the event.

sourceType - The type of the source of this event.

sourceID - The ID of the source of this event.

path - The path for which the event has been created.

Throws:

java.io.IOException - If retrieving the basic file attributes of the designated path fails, an IOException will be thrown.

Method Detail

getPath

public java.nio.file.Path getPath()

Description copied from interface: FileEvent

Gets the path that caused this event.

Specified by:

getPath in interface FileEvent

Returns:

The path that caused this event.

getFileAttributes

public java.nio.file.attribute.BasicFileAttributes getFileAttributes()

Description copied from interface: FileEvent

Gets the basic file attributes of the path of this event.

Specified by:

getFileAttributes in interface FileEvent

Returns:

The basic file attributes of the path of this event.

getName

public java.lang.String getName()

Description copied from interface: FileEvent

Gets the name of the file that caused this event.

Specified by:

getName in interface FileEvent

Returns:

The name of the file that caused this event.

getLastModified

public java.util.Date getLastModified()

Description copied from interface: FileEvent

Gets the date the file that caused this event has been modified.

Specified by:

getLastModified in interface FileEvent

Returns:

The date the file that caused this event has been modified.

getAsURI

public java.net.URI getAsURI()

Description copied from interface: FileEvent

Gets the URI of the file that caused this event.

Specified by:

getAsURI in interface FileEvent

Returns:

The URI of the file that caused this event.

getAsURL

public java.net.URL getAsURL()

Description copied from interface: FileEvent

Gets the URL of the file that caused this event.

Specified by:

getAsURL in interface FileEvent

Returns:

The URL of the file that caused this event.

getFile

public java.io.File getFile()

Description copied from interface: FileEvent

Gets the file that caused this event.
Important: Only change this file if you consume this event!

Specified by:

getFile in interface FileEvent

Returns:

The file that caused this event.