Fiotcher

A small resource scanning and handling processor library.

Examples

Usage examples can be found at:

1. Basic usage - /test/kotlin/com/tsarev/fiotcher/api/BasicUsageTest.kt
2. Advanced usage - /test/kotlin/com/tsarev/fiotcher/api/AdvancedUsageTest.kt
3. Error handling usage - /test/kotlin/com/tsarev/fiotcher/api/ErrorHandlingTest.kt
4. Lifecycle control usage - /test/kotlin/com/tsarev/fiotcher/api/LifecycleUsageTest.kt

Also, there is self parse test results example in module example (/src/example/kotlin/com/tsarev/fiotcher/liveJunitReportsParse.kt).

Note: For IntelliJ users there are two saved run configurations, first to build, and second to launch self parse example.

About

Fiothcer is a tracking/processing library build upon a subscriber publisher pattern.

The main idea is to simplify implementing various processors and trackers and glue the into single chain.

It allows to:

1. Implement various trackers, just extending base Tracker class.
2. Register various listeners, using ProcessorManager API, or lower level Processor API.
3. Start and stop listeners and trackers, following Stoppable interface methods.

Core tracker implementations are:

1. FileSystemTracker - tracks file system changes within specified directory.

Listeners are allowed to do asynchronous processing, see ProcessorManager#ListenerBuilder interface for details.

Core listeners extensions are located at extensions.kt. They include:

1. handleSax - parsing xml files with default java API SAX parser, each file asynchronously.
2. handleDom - parsing xml files with default java API DOM parser, each file asynchronously.
3. handleLines - parse text files line by line, each line asynchronously (possible), each file asynchronously.
4. handleFiles - handle raw files, each file asynchronously.

Current limitations

There are some limitations at the moment, that can be eliminated within current design:

1. Current FileSystemTracker implementation is based upon Java API WatchService, so if nested directories are created fast, so file can be lost. This can be fixed with fallback method, scanning with plain BFS search at second thread and registering new directories in the watcher service.

A treasure lies beneath this endless abyss of code history