org.apache.sling.spi.resource.provider

Interface ObserverConfiguration

public interface ObserverConfiguration

A observer configuration describes active configurations from registered listeners.

Since:

1.0.0 (Sling API Bundle 2.11.0)

Method Summary

Modifier and Type	Method and Description
java.util.Set<ResourceChange.ChangeType>	getChangeTypes() The set of types listeners are interested in.
PathSet	getExcludedPaths() The set of excluded paths.
PathSet	getPaths() The set of paths this listener is interested in.
boolean	includeExternal() true if a listener is interested in external events.
boolean	matches(java.lang.String path) Checks whether a path matches one of the paths of this configuration but is not in the excluded paths set.

Method Detail

includeExternal

boolean includeExternal()

true if a listener is interested in external events.

getPaths

PathSet getPaths()

The set of paths this listener is interested in. Each entry is absolute.

Returns:

Non empty set of paths

getExcludedPaths

PathSet getExcludedPaths()

The set of excluded paths. All the paths are sub paths from one entry of getPaths()

Returns:

A set of excluded paths, might be empty.

getChangeTypes

java.util.Set<ResourceChange.ChangeType> getChangeTypes()

The set of types listeners are interested in.

Returns:

Non empty set of types

matches

boolean matches(java.lang.String path)

Checks whether a path matches one of the paths of this configuration but is not in the excluded paths set.

Parameters:

path - The path to check

Returns:

true if the path matches the configuration.