Package org.openhab.core.transform

Class FileTransformationProvider

java.lang.Object

org.openhab.core.service.AbstractWatchService

org.openhab.core.transform.FileTransformationProvider

All Implemented Interfaces:

Provider<Transformation>, TransformationProvider

@NonNullByDefault
public class FileTransformationProvider
extends AbstractWatchService
implements TransformationProvider

The FileTransformationProvider implements a TransformationProvider for supporting transformations stored in configuration files

Author:

Jan N. Klug - Initial contribution

Field Summary

Fields inherited from class org.openhab.core.service.AbstractWatchService

pathToWatch, watchQueueReader

Constructor Summary

Constructors

Constructor	Description
FileTransformationProvider()

Method Summary

Modifier and Type	Method	Description
void	addProviderChangeListener(ProviderChangeListener<Transformation> listener)	Adds a ProviderChangeListener which must be notified if there are changes concerning the elements provided by the Provider.
Collection<Transformation>	getAll()	Returns a collection of all elements.
protected WatchEvent.Kind<?> @Nullable []	getWatchEventKinds(Path directory)	Provides the WatchKeys for the registration of the directory, which will be registered in the watch service.
protected void	processWatchEvent(WatchEvent<?> event, WatchEvent.Kind<?> kind, Path path)	Processes the given watch event.
void	removeProviderChangeListener(ProviderChangeListener<Transformation> listener)	Removes a ProviderChangeListener.
protected boolean	watchSubDirectories()	Determines whether the subdirectories of the source path (determined by the AbstractWatchService.getSourcePath()) will be watched or not.

Methods inherited from class org.openhab.core.service.AbstractWatchService

activate, changeWatchDirectory, deactivate, getSourcePath

Methods inherited from class java.lang.Object

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

Constructor Detail

FileTransformationProvider

public FileTransformationProvider()

Method Detail

addProviderChangeListener

public void addProviderChangeListener(ProviderChangeListener<Transformation> listener)

Description copied from interface: Provider

Adds a ProviderChangeListener which must be notified if there are changes concerning the elements provided by the Provider.

Specified by:

addProviderChangeListener in interface Provider<Transformation>

Parameters:

listener - the listener to be added

removeProviderChangeListener

public void removeProviderChangeListener(ProviderChangeListener<Transformation> listener)

Description copied from interface: Provider

Removes a ProviderChangeListener.

Specified by:

removeProviderChangeListener in interface Provider<Transformation>

Parameters:

listener - the listener to be removed.

getAll

public Collection<Transformation> getAll()

Description copied from interface: Provider

Returns a collection of all elements.

Specified by:

getAll in interface Provider<Transformation>

Returns:

collection of all elements

watchSubDirectories

protected boolean watchSubDirectories()

Description copied from class: AbstractWatchService

Determines whether the subdirectories of the source path (determined by the AbstractWatchService.getSourcePath()) will be watched or not.

Specified by:

watchSubDirectories in class AbstractWatchService

Returns:

true if the subdirectories will be watched and false if only the source path (determined by the AbstractWatchService.getSourcePath()) will be watched

getWatchEventKinds

protected WatchEvent.Kind<?> @Nullable [] getWatchEventKinds(Path directory)

Description copied from class: AbstractWatchService

Provides the WatchKeys for the registration of the directory, which will be registered in the watch service.

Specified by:

getWatchEventKinds in class AbstractWatchService

Parameters:

directory - the directory, which will be registered in the watch service

Returns:

The array of WatchKeys for the registration or null if no registration has been done.

processWatchEvent

protected void processWatchEvent(WatchEvent<?> event,
                                 WatchEvent.Kind<?> kind,
                                 Path path)

Description copied from class: AbstractWatchService

Processes the given watch event. Note that the kind and the number of the events for the watched directory is a platform dependent (see the "Platform dependencies" sections of WatchService).

Specified by:

processWatchEvent in class AbstractWatchService

Parameters:

event - the watch event to be handled

kind - the event's kind

path - the path of the event (resolved to the AbstractWatchService.pathToWatch)