FileObserver

java.lang.Object
- com.highqsoft.syssupport.win32.fileobserver.FileObserver

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

FileObserverBinding
```
public class FileObserver
extends java.lang.Object
implements java.lang.Runnable
```
The win32 native file observer.

Since:

$Date: 2017/04/07 06:34:55 $

Version:

$Revision: 1.20 $

Author:

Andreas Hofmann

See Also:

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class FileObserver.FireThread
The runnable that calls the listener.

Nested Classes
Modifier and Type	Class and Description
`class`	`FileObserver.FireThread` The runnable that calls the listener.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.Object`	`arrLock`
`static int`	`FILE_NOTIFY_CHANGE_ATTRIBUTES` Any attribute change in the watched directory or subtree causes a change notification wait operation to return.
`static int`	`FILE_NOTIFY_CHANGE_CREATION`
`static int`	`FILE_NOTIFY_CHANGE_DIR_NAME` Any directory-name change in the watched directory or subtree causes a change notification wait operation to return.
`static int`	`FILE_NOTIFY_CHANGE_FILE_NAME` Any file name change in the watched directory or subtree causes a change notification wait operation to return.
`static int`	`FILE_NOTIFY_CHANGE_LAST_ACCESS`
`static int`	`FILE_NOTIFY_CHANGE_LAST_WRITE` Any change to the last write-time of files in the watched directory or subtree causes a change notification wait operation to return.
`static int`	`FILE_NOTIFY_CHANGE_SECURITY` Any security-descriptor change in the watched directory or subtree causes a change notification wait operation to return.
`static int`	`FILE_NOTIFY_CHANGE_SIZE` Any file-size change in the watched directory or subtree causes a change notification wait operation to return.
`protected int`	`flags`
`protected static boolean`	`libLoaded`
`static java.lang.String`	`LIBRARY_NAME`
`protected java.lang.Object`	`listenerLock`
`protected javax.swing.event.EventListenerList`	`listeners`
`protected long`	`nativeContext`
`protected java.lang.String[]`	`observables`
`protected java.lang.Thread`	`thread`
`protected int`	`timeout`
`protected boolean`	`watchSubTree`

Constructor Summary

Constructors
Constructor and Description

FileObserver()
The default constructor.

Constructors
Constructor and Description
`FileObserver()` The default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`add(int index, java.lang.String observable)` Add an observable.
`int`	`add(java.lang.String observable)` Add an observable.
`void`	`addFileObserverListener(FilePollerListenerInterface listener)` Add an event listener.
`protected void`	`finalize()` Release the native pointer.
`void`	`fireIndexEvent(int index)` Fire an index event.
`java.lang.String`	`get(int index)` Get an observable.
`static int`	`getAllFlags()` Get all flags.
`static int`	`getAttributeFlag()` Get the native flag to observe the file attributes.
`static int`	`getCreationFlag()` Get the native flag to observe file creation.
`static int`	`getDirectoryFlag()` Get the native flag to observe the creation, renames and deletion of directories.
`static int`	`getFilenameFlag()` Get the native flag to observe the creation, renames and deletion of filenames.
`int`	`getFlags()` Get the classification flags.
`static int`	`getLastAccessFlag()` Get the native flag to observe the last access.
`static int`	`getLastWriteFlag()` Get the native flag to observe the last write.
`static int`	`getMaxCount()` Get the maximum observation count.
`static int`	`getSecurityFlag()` Get the native flag to observe the security attribute.
`static int`	`getSizeFlag()` Get the native flag to observe the filesize.
`java.lang.Thread`	`getThread()` Returns the thread that observes.
`int`	`getTimeout()` Get the timeout in milliseconds.
`boolean`	`getWatchSubTree()` Get the subtree flag.
`static boolean`	`isLibraryLoaded()` This method returns the library load state.
`boolean`	`isStopped()` Return a boolean whether the thread is stopped.
`static void`	`main(java.lang.String[] args)` The main testing routine.
`void`	`release()` Release the notifications.
`java.lang.String`	`remove(int index)` Remove an entry.
`void`	`removeFileObserverListener(FilePollerListenerInterface listener)` Remove an event listener.
`void`	`run()` The run method.
`void`	`setFlags(int flags)` Set the flags that classify the observer.
`void`	`setTimeout(int timeout)` Set the observer timeout.
`void`	`setWatchSubTree(boolean flag)` Set the flag to obtain subtrees.
`int`	`size()` Get the size of observable array.
`void`	`start()` Called by the main program, the hosting frame, or the hosting applet to inform this application that it should start its execution.
`void`	`startObservation(java.lang.Thread thread)` Initialize the observation.
`void`	`stop()` Called by the main program, the hosting frame, or the hosting applet to inform this application that it should stop its execution.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- LIBRARY_NAME
```
public static final java.lang.String LIBRARY_NAME
```
  See Also:
  Constant Field Values
- FILE_NOTIFY_CHANGE_FILE_NAME
```
public static final int FILE_NOTIFY_CHANGE_FILE_NAME
```
  Any file name change in the watched directory or subtree causes a change notification wait operation to return. Changes include renaming, creating, or deleting a file name.
  
  See Also:
  Constant Field Values
- FILE_NOTIFY_CHANGE_DIR_NAME
```
public static final int FILE_NOTIFY_CHANGE_DIR_NAME
```
  Any directory-name change in the watched directory or subtree causes a change notification wait operation to return. Changes include creating or deleting a directory.
  
  See Also:
  Constant Field Values
- FILE_NOTIFY_CHANGE_ATTRIBUTES
```
public static final int FILE_NOTIFY_CHANGE_ATTRIBUTES
```
  Any attribute change in the watched directory or subtree causes a change notification wait operation to return.
  
  See Also:
  Constant Field Values
- FILE_NOTIFY_CHANGE_SIZE
```
public static final int FILE_NOTIFY_CHANGE_SIZE
```
  Any file-size change in the watched directory or subtree causes a change notification wait operation to return. The operating system detects a change in file size only when the file is written to the disk. For operating systems that use extensive caching, detection occurs only when the cache is sufficiently flushed.
  
  See Also:
  Constant Field Values
- FILE_NOTIFY_CHANGE_LAST_WRITE
```
public static final int FILE_NOTIFY_CHANGE_LAST_WRITE
```
  Any change to the last write-time of files in the watched directory or subtree causes a change notification wait operation to return. The operating system detects a change to the last write-time only when the file is written to the disk. For operating systems that use extensive caching, detection occurs only when the cache is sufficiently flushed.
  
  See Also:
  Constant Field Values
- FILE_NOTIFY_CHANGE_LAST_ACCESS
```
public static final int FILE_NOTIFY_CHANGE_LAST_ACCESS
```
  See Also:
  Constant Field Values
- FILE_NOTIFY_CHANGE_CREATION
```
public static final int FILE_NOTIFY_CHANGE_CREATION
```
  See Also:
  Constant Field Values
- FILE_NOTIFY_CHANGE_SECURITY
```
public static final int FILE_NOTIFY_CHANGE_SECURITY
```
  Any security-descriptor change in the watched directory or subtree causes a change notification wait operation to return.
  
  See Also:
  Constant Field Values
- libLoaded
```
protected static boolean libLoaded
```
- nativeContext
```
protected long nativeContext
```
- watchSubTree
```
protected boolean watchSubTree
```
- flags
```
protected int flags
```
- timeout
```
protected int timeout
```
- observables
```
protected java.lang.String[] observables
```
- thread
```
protected java.lang.Thread thread
```
- arrLock
```
protected java.lang.Object arrLock
```
- listenerLock
```
protected java.lang.Object listenerLock
```
- listeners
```
protected javax.swing.event.EventListenerList listeners
```

Constructor Detail
- FileObserver
```
public FileObserver()
```
  The default constructor.

Method Detail

getFilenameFlag
```
public static int getFilenameFlag()
```
Get the native flag to observe the creation, renames and deletion of filenames.

getDirectoryFlag
```
public static int getDirectoryFlag()
```
Get the native flag to observe the creation, renames and deletion of directories.

getAttributeFlag
```
public static int getAttributeFlag()
```
Get the native flag to observe the file attributes.

getSizeFlag
```
public static int getSizeFlag()
```
Get the native flag to observe the filesize.

getLastWriteFlag
```
public static int getLastWriteFlag()
```
Get the native flag to observe the last write.

getLastAccessFlag
```
public static int getLastAccessFlag()
```
Get the native flag to observe the last access.

getCreationFlag
```
public static int getCreationFlag()
```
Get the native flag to observe file creation.

getSecurityFlag
```
public static int getSecurityFlag()
```
Get the native flag to observe the security attribute.

getMaxCount
```
public static int getMaxCount()
```
Get the maximum observation count.

release
```
public void release()
```
Release the notifications.

startObservation

public void startObservation(java.lang.Thread thread)

Initialize the observation.

finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
Release the native pointer.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

getAllFlags
```
public static int getAllFlags()
```
Get all flags.

isLibraryLoaded
```
public static boolean isLibraryLoaded()
```
This method returns the library load state.

Returns:
true if the library was loaded.

setWatchSubTree
```
public void setWatchSubTree(boolean flag)
```
Set the flag to obtain subtrees.

Parameters:
flag - if true the observer will watch the subtree.

getWatchSubTree
```
public boolean getWatchSubTree()
```
Get the subtree flag.

Returns:
true if the observer watch on subtree.

setFlags

public void setFlags(int flags)

Set the flags that classify the observer. Use the native method to obtain the native flags. Currently there is a set of constants defined in the winnt.h
ATTENTION: These values may be changed in another windows release. The value are available as final definitions in this class.

FILE_NOTIFY_CHANGE_FILE_NAME	0x00000001
FILE_NOTIFY_CHANGE_DIR_NAME	0x00000002
FILE_NOTIFY_CHANGE_ATTRIBUTES	0x00000004
FILE_NOTIFY_CHANGE_SIZE	0x00000008
FILE_NOTIFY_CHANGE_LAST_WRITE	0x00000010
FILE_NOTIFY_CHANGE_LAST_ACCESS	0x00000020
FILE_NOTIFY_CHANGE_CREATION	0x00000040
FILE_NOTIFY_CHANGE_SECURITY	0x00000100

Parameters:: flags - Can be one or more of the native flags combined by a logical OR.

getFlags
```
public int getFlags()
```
Get the classification flags.

Returns:
the classification flags.

setTimeout
```
public void setTimeout(int timeout)
```
Set the observer timeout. Use the native method to obtain the native flags.

Parameters:
timeout - time in milliseconds (default 10000).

getTimeout
```
public int getTimeout()
```
Get the timeout in milliseconds.

Returns:
the timeout.

add
```
public int add(int index,
      java.lang.String observable)
```
Add an observable.

Parameters:
index - the array position.
path - the observable.

Returns:
the index of the observable.

add
```
public int add(java.lang.String observable)
```
Add an observable.

Parameters:
path - the observable.

Returns:
the index of the observable.

get
```
public java.lang.String get(int index)
```
Get an observable.

Returns:
the observable.

remove
```
public java.lang.String remove(int index)
```
Remove an entry.

Parameters:
index - the index of the entry to be removed.

addFileObserverListener
```
public void addFileObserverListener(FilePollerListenerInterface listener)
```
Add an event listener.

Parameters:
listener - the event listener.

removeFileObserverListener
```
public void removeFileObserverListener(FilePollerListenerInterface listener)
```
Remove an event listener.

Parameters:
listener - the event listener.

size
```
public int size()
```
Get the size of observable array.

Returns:
the size.

fireIndexEvent
```
public void fireIndexEvent(int index)
```
Fire an index event.

Parameters:
index - The index into the observable array.

run
```
public void run()
```
The run method.

Specified by:

run in interface java.lang.Runnable

start
```
public void start()
```
Called by the main program, the hosting frame, or the hosting applet to inform this application that it should start its execution. Causes this application thread to begin execution; the Java Virtual Machine calls the run method of this thread.

stop
```
public void stop()
```
Called by the main program, the hosting frame, or the hosting applet to inform this application that it should stop its execution.

getThread
```
public java.lang.Thread getThread()
```
Returns the thread that observes.

Returns:
the thread or null.

isStopped
```
public boolean isStopped()
```
Return a boolean whether the thread is stopped.

Returns:
true if the observer thread is stopped.

main

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

The main testing routine.

Class FileObserver

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LIBRARY_NAME

FILE_NOTIFY_CHANGE_FILE_NAME

FILE_NOTIFY_CHANGE_DIR_NAME

FILE_NOTIFY_CHANGE_ATTRIBUTES

FILE_NOTIFY_CHANGE_SIZE

FILE_NOTIFY_CHANGE_LAST_WRITE

FILE_NOTIFY_CHANGE_LAST_ACCESS

FILE_NOTIFY_CHANGE_CREATION

FILE_NOTIFY_CHANGE_SECURITY

libLoaded

nativeContext

watchSubTree

flags

timeout

observables

thread

arrLock

listenerLock

listeners

Constructor Detail

FileObserver

Method Detail

getFilenameFlag

getDirectoryFlag

getAttributeFlag

getSizeFlag

getLastWriteFlag

getLastAccessFlag

getCreationFlag

getSecurityFlag

getMaxCount

release

startObservation

finalize

getAllFlags

isLibraryLoaded

setWatchSubTree

getWatchSubTree

setFlags

getFlags

setTimeout

getTimeout

add

add

get

remove

addFileObserverListener

removeFileObserverListener

size

fireIndexEvent

run

start

stop

getThread

isStopped

main