com.highqsoft.util

Class FilePoller

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

com.highqsoft.fwk.FwkThread

com.highqsoft.util.FilePoller

All Implemented Interfaces:

FwkDescriptionInterface, FwkInterface, FwkThreadInterface, FwkTransferableInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.io.Serializable, java.lang.Cloneable, java.lang.Runnable

public class FilePoller
extends FwkThread

This object polls a directory and send messages on newly created files. It is a thread that polls a user specified directory for files

Since:

$Date: 2017/04/06 13:29:12 $

Version:

$Revision: 1.13 $

Author:

Uli Bleicher

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FilePoller.FilePollerElement The file list elements.
class	FilePoller.FilePollerFilter The default file filter class.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	dir
protected FwkSortedArray	elems
protected java.io.FileFilter	filter
protected FwkArray	listeners
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkThread

thread, threadPrio

Fields inherited from class com.highqsoft.fwk.FwkDescription

author, buildnr, className, company, copyright, creationDate, dateFormatString, description, eMail, FWK_ICON, FWK_ICON_ARRAY, FWK_ICON_BG, FWK_ICON_BG_ARRAY, FWK_ICON_BG_LARGE, FWK_ICON_BG_LARGE_ARRAY, FWK_ICON_LARGE, FWK_ICON_LARGE_ARRAY, icon, ICON, iconCount, iconKey, internetAddress, name, titleName

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Constructor Summary

Constructors

Constructor and Description
FilePoller(java.lang.String directory, java.lang.String filter) The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addFilePollerListener(FilePollerListenerInterface listener) Add a file poller listeners.
void	fireEvent(int type, long modified, java.lang.String path) Fire an event.
FwkArrayInterface	getFilePollerListeners() Retrieves all registered listeners.
java.lang.String	getVersion() Return the version string of the FWK component.
static void	main(java.lang.String[] args) The Main test body.
void	removeFilePollerListener(FilePollerListenerInterface listener) Remove a file poller listeners.
void	run() Run the thread for the PumaCommunicatorCommandThread if the directory is valid.

Methods inherited from class com.highqsoft.fwk.FwkThread

getPriority, isInterrupted, setPriority, start, stop

Methods inherited from class com.highqsoft.fwk.FwkDescription

getAuthor, getBuild, getClassName, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, getTransferData, getTransferDataFlavors, isDataFlavorSupported, lostOwnership, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName, toString

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion, release

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

getAuthor, getBuild, getClassName, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

release

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

filter

protected java.io.FileFilter filter

dir

protected java.io.File dir

elems

protected FwkSortedArray elems

listeners

protected FwkArray listeners

Constructor Detail

FilePoller

public FilePoller(java.lang.String directory,
          java.lang.String filter)

The constructor. This constructor expect the property value of PumaCommunicator.Path. If these value is a valid URL then the commandhandler polls periodically the file (command directory).

Parameters:

directory - the directory where the poller should listen.

filter - The file filter.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class FwkThread

run

public void run()

Run the thread for the PumaCommunicatorCommandThread if the directory is valid.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class FwkThread

fireEvent

public void fireEvent(int type,
             long modified,
             java.lang.String path)

Fire an event.

Parameters:

type - The type of the event.

path - The file path.

addFilePollerListener

public void addFilePollerListener(FilePollerListenerInterface listener)

Add a file poller listeners.

Parameters:

listener - The listener.

getFilePollerListeners

public FwkArrayInterface getFilePollerListeners()

Retrieves all registered listeners.

Returns:

An array that contains all registered listeners.

removeFilePollerListener

public void removeFilePollerListener(FilePollerListenerInterface listener)

Remove a file poller listeners.

Parameters:

listener - The listener.

main

public static void main(java.lang.String[] args)

The Main test body.