DirWatchService (jexler-core 4.0.1 API)

ch.artecat.jexler.service.DirWatchService

Directory watch service, creates an event when a file in a given directory is created, modified oder deleted.
Authors:
Jex Jexler (Alain Stalder)

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`DirWatchService.DirWatchJob`	Internal class, only public because otherwise not called by quartz scheduler.

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`cron`
`java.io.File`	`dir`
`java.util.List<WatchEvent.Kind<java.nio.file.Path>>`	`kinds`
`java.util.List<WatchEvent.Modifier>`	`modifiers`
`org.quartz.Scheduler`	`scheduler`

Constructor Summary

Constructors
Constructor and description
`DirWatchService (Jexler jexler, java.lang.String id)` Constructor.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getCron()` Get cron pattern.
	`java.io.File`	`getDir()` Get directory to watch.
	`Jexler`	`getJexler()` Get jexler.
	`java.util.List<WatchEvent.Kind<java.nio.file.Path>>`	`getKinds()` Get kinds of events to watch for.
	`java.util.List<WatchEvent.Modifier>`	`getModifiers()` Get modifiers when watching for events.
	`org.quartz.Scheduler`	`getScheduler()` Get quartz scheduler.
	`DirWatchService`	`setCron(java.lang.String cron)` Set cron pattern for when to check.
	`DirWatchService`	`setDir(java.io.File dir)` Set directory to watch.
	`DirWatchService`	`setKinds(java.util.List<WatchEvent.Kind<java.nio.file.Path>> kinds)` Set kinds of events to watch for.
	`DirWatchService`	`setModifiers(java.util.List<WatchEvent.Modifier> modifiers)` Set modifiers when watching for events.
	`DirWatchService`	`setScheduler(org.quartz.Scheduler scheduler)` Set quartz scheduler.
	`void`	`start()`
	`void`	`stop()`
	`void`	`zap()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class ServiceBase`	`getId, getState, setState`
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - java.lang.String cron
  - java.io.File dir
  - java.util.List<WatchEvent.Kind<java.nio.file.Path>> kinds
  - java.util.List<WatchEvent.Modifier> modifiers
  - org.quartz.Scheduler scheduler
- Constructor Detail
  - DirWatchService(Jexler jexler, java.lang.String id)
    
    Constructor.
    Parameters:
    jexler - the jexler to send events to
    id - the id of the service
- Method Detail
  - java.lang.String getCron()
    
    Get cron pattern.
  - java.io.File getDir()
    
    Get directory to watch.
  - Jexler getJexler()
    
    Get jexler.
  - java.util.List<WatchEvent.Kind<java.nio.file.Path>> getKinds()
    
    Get kinds of events to watch for.
  - java.util.List<WatchEvent.Modifier> getModifiers()
    
    Get modifiers when watching for events.
  - org.quartz.Scheduler getScheduler()
    
    Get quartz scheduler.
  - DirWatchService setCron(java.lang.String cron)
    
    Set cron pattern for when to check. Default is every 5 seconds.
    Returns:
    this (for chaining calls)
  - DirWatchService setDir(java.io.File dir)
    
    Set directory to watch. Default if not set is the directory that contains the jexler.
    Parameters:
    dir - directory to watch
    Returns:
    this (for chaining calls)
  - DirWatchService setKinds(java.util.List<WatchEvent.Kind<java.nio.file.Path>> kinds)
    
    Set kinds of events to watch for. Default is standard events for create, modify and delete.
    Parameters:
    kinds
    Returns:
  - DirWatchService setModifiers(java.util.List<WatchEvent.Modifier> modifiers)
    
    Set modifiers when watching for events. On Mac OS X, by default the file system seems to be polled every 10 seconds; to reduce this to 2 seconds, pass a modifier com.sun.nio.file.SensitivityWatchEventModifier.HIGH.
    Parameters:
    modifiers
    Returns:
  - DirWatchService setScheduler(org.quartz.Scheduler scheduler)
    
    Set quartz scheduler. Default is a scheduler shared by all jexlers in the same jexler container.
    Returns:
    this (for chaining calls)
  - @java.lang.Override void start()
  - @java.lang.Override void stop()
  - @java.lang.Override void zap()

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class DirWatchService

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.String cron

java.io.File dir

java.util.List<WatchEvent.Kind<java.nio.file.Path>> kinds

java.util.List<WatchEvent.Modifier> modifiers

org.quartz.Scheduler scheduler

Constructor Detail

DirWatchService(Jexler jexler, java.lang.String id)

Method Detail

java.lang.String getCron()

java.io.File getDir()

Jexler getJexler()

java.util.List<WatchEvent.Kind<java.nio.file.Path>> getKinds()

java.util.List<WatchEvent.Modifier> getModifiers()

org.quartz.Scheduler getScheduler()

DirWatchService setCron(java.lang.String cron)

DirWatchService setDir(java.io.File dir)

DirWatchService setKinds(java.util.List<WatchEvent.Kind<java.nio.file.Path>> kinds)

DirWatchService setModifiers(java.util.List<WatchEvent.Modifier> modifiers)

DirWatchService setScheduler(org.quartz.Scheduler scheduler)

@java.lang.Override void start()

@java.lang.Override void stop()

@java.lang.Override void zap()