com.facebook.buck.io.watchman

Class Watchman

java.lang.Object

com.facebook.buck.io.watchman.Watchman

public abstract class Watchman
extends Object

Contains the configuration for a Watchman client as well as the ability to create a client.

Constructor Summary

Constructors

Constructor and Description
Watchman(com.google.common.collect.ImmutableMap<AbsPath,ProjectWatch> projectWatches, com.google.common.collect.ImmutableSet<Capability> capabilities, com.google.common.collect.ImmutableMap<String,String> clockIds, Optional<Path> transportPath, String version)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableMap<AbsPath,WatchmanCursor>	buildClockWatchmanCursorMap() Build.
com.google.common.collect.ImmutableMap<AbsPath,WatchmanCursor>	buildNamedWatchmanCursorMap() Build.
abstract WatchmanClient	createClient() Note this method will throw an IOException if: getTransportPath() returns Optional.empty() It cannot establish a connection to Watchman.
com.google.common.collect.ImmutableSet<Capability>	getCapabilities()
com.google.common.collect.ImmutableMap<String,String>	getClockIds()
com.google.common.collect.ImmutableMap<AbsPath,ProjectWatch>	getProjectWatches()
Optional<Path>	getTransportPath()
String	getVersion()
boolean	hasWildmatchGlob()

Methods inherited from class java.lang.Object

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

Constructor Detail

Watchman

public Watchman(com.google.common.collect.ImmutableMap<AbsPath,ProjectWatch> projectWatches,
                com.google.common.collect.ImmutableSet<Capability> capabilities,
                com.google.common.collect.ImmutableMap<String,String> clockIds,
                Optional<Path> transportPath,
                String version)

Method Detail

buildClockWatchmanCursorMap

public com.google.common.collect.ImmutableMap<AbsPath,WatchmanCursor> buildClockWatchmanCursorMap()

Build.

buildNamedWatchmanCursorMap

public com.google.common.collect.ImmutableMap<AbsPath,WatchmanCursor> buildNamedWatchmanCursorMap()

Build.

getProjectWatches

public com.google.common.collect.ImmutableMap<AbsPath,ProjectWatch> getProjectWatches()

getCapabilities

public com.google.common.collect.ImmutableSet<Capability> getCapabilities()

getClockIds

public com.google.common.collect.ImmutableMap<String,String> getClockIds()

hasWildmatchGlob

public boolean hasWildmatchGlob()

getTransportPath

public Optional<Path> getTransportPath()

getVersion

public String getVersion()

createClient

public abstract WatchmanClient createClient()
                                     throws IOException

Note this method will throw an IOException if:

• getTransportPath() returns Optional.empty()
• It cannot establish a connection to Watchman.

Returns:

a new client that the caller is responsible for closing.

Throws:

IOException