com.credibledoc.substitution.reporting.tracking

Class TrackingService

java.lang.Object

com.credibledoc.substitution.reporting.tracking.TrackingService

public class TrackingService
extends Object

Watches directories for changes to files and runs template generation in case when some template in the tracked directory changed.

This stateful object contains watchService, map, substitutionContext and fragmentDependencyMap instances.

Author:

Kyrylo Semenko

Field Summary

Fields

Modifier and Type	Field and Description
private Map<Path,Set<Path>>	fragmentDependencyMap Key is a fragment that can be changed, and Values are dependant files which should be generated in case of the fragment change.
private static org.slf4j.Logger	logger
private Map<WatchKey,Path>	map Contains Paths watched by WatchKeys.
private SubstitutionContext	substitutionContext Contains the application current state.
private WatchService	watchService See the WatchService description.

Constructor Summary

Constructors

Constructor and Description
TrackingService(SubstitutionContext substitutionContext)

Method Summary

Modifier and Type	Method and Description
private void	addFromRepository()
private void	createDir(Path path)
private void	deleteDir(Path path)
private void	deleteDirRecursively(File directoryToDelete)
private void	deleteFragment(Path path)
private Set<Path>	getChildrenFragmentTemplates(Path path)
private boolean	isFragment(Path path)
private void	processEvent(Path dir, WatchEvent<?> event)
private void	processEvents()
private void	processFile(WatchEvent.Kind<?> kind, Path path)
private TrackingResult	processWatchKey(WatchKey watchKey)
private void	register(Path path) Register the given directory with the WatchService
private void	registerAll(Path start) Register the given directory, all its sub-directories and all files, with the watchService.
private void	reloadFragments(Path path)
void	track()

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.slf4j.Logger logger

watchService

private final WatchService watchService

See the WatchService description.

map

private final Map<WatchKey,Path> map

Contains Paths watched by WatchKeys.

substitutionContext

private final SubstitutionContext substitutionContext

Contains the application current state.

fragmentDependencyMap

private final Map<Path,Set<Path>> fragmentDependencyMap

Key is a fragment that can be changed, and Values are dependant files which should be generated in case of the fragment change.

Constructor Detail

TrackingService

public TrackingService(SubstitutionContext substitutionContext)
                throws IOException

Throws:

IOException

Method Detail

addFromRepository

private void addFromRepository()

track

public void track()
           throws IOException,
                  InterruptedException

Throws:

IOException

InterruptedException

processEvents

private void processEvents()
                    throws IOException,
                           InterruptedException

Throws:

IOException

InterruptedException

processWatchKey

private TrackingResult processWatchKey(WatchKey watchKey)
                                throws IOException

Throws:

IOException

processEvent

private void processEvent(Path dir,
                          WatchEvent<?> event)
                   throws IOException

Throws:

IOException

isFragment

private boolean isFragment(Path path)

processFile

private void processFile(WatchEvent.Kind<?> kind,
                         Path path)

deleteFragment

private void deleteFragment(Path path)

getChildrenFragmentTemplates

private Set<Path> getChildrenFragmentTemplates(Path path)

createDir

private void createDir(Path path)
                throws IOException

Throws:

IOException

deleteDir

private void deleteDir(Path path)
                throws IOException

Throws:

IOException

deleteDirRecursively

private void deleteDirRecursively(File directoryToDelete)
                           throws IOException

Throws:

IOException

registerAll

private void registerAll(Path start)
                  throws IOException

Register the given directory, all its sub-directories and all files, with the watchService.

Parameters:

start - the root path for watching

Throws:

IOException - in case of read or write exceptions

reloadFragments

private void reloadFragments(Path path)

register

private void register(Path path)
               throws IOException

Register the given directory with the WatchService

Parameters:

path - the directory for watching

Throws:

IOException - in case of read or write exceptions