Package org.apache.sling.resourceresolver.impl.observation

Class BasicObserverConfiguration

java.lang.Object

org.apache.sling.resourceresolver.impl.observation.BasicObserverConfiguration

All Implemented Interfaces:

ObserverConfiguration

public class BasicObserverConfiguration
extends Object
implements ObserverConfiguration

Implementation of a ObserverConfiguration

Constructor Summary

Constructors

Constructor	Description
BasicObserverConfiguration(PathSet set)
BasicObserverConfiguration(PathSet paths, Set<ResourceChange.ChangeType> types, boolean isExternal, PathSet excludePaths, Set<String> propertyNamesHint)

Method Summary

Modifier and Type	Method	Description
void	addListener(ResourceChangeListenerInfo listener)	Add a listener
boolean	equals(Object obj)
Set<ResourceChange.ChangeType>	getChangeTypes()	The set of types listeners are interested in.
PathSet	getExcludedPaths()	The set of excluded paths.
List<ResourceChangeListenerInfo>	getListeners()	All listeners associated with this configuration
PathSet	getPaths()	The set of paths this listener is interested in.
Set<String>	getPropertyNamesHint()	Set containing the set of property names which serves as an optional hint for the underlying to only report property changes enlisted, ie the underlying might ignore this.
int	hashCode()
boolean	includeExternal()	true if a listener is interested in external events.
boolean	matches(String path)	Checks whether a path matches one of the paths of this configuration but is not in the excluded paths set.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BasicObserverConfiguration

public BasicObserverConfiguration(PathSet paths,
 Set<ResourceChange.ChangeType> types,
 boolean isExternal,
 PathSet excludePaths,
 Set<String> propertyNamesHint)

BasicObserverConfiguration

public BasicObserverConfiguration(PathSet set)

Method Details

addListener

public void addListener(ResourceChangeListenerInfo listener)

Add a listener

Parameters:

listener - The listener

getListeners

public List<ResourceChangeListenerInfo> getListeners()

All listeners associated with this configuration

Returns:

List of listeners, might be empty

includeExternal

public boolean includeExternal()

Description copied from interface: ObserverConfiguration

true if a listener is interested in external events.

Specified by:

includeExternal in interface ObserverConfiguration

Returns:

true if a listener is interested in external events.

getPaths

public PathSet getPaths()

Description copied from interface: ObserverConfiguration

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

Specified by:

getPaths in interface ObserverConfiguration

Returns:

Non empty set of paths

getExcludedPaths

public PathSet getExcludedPaths()

Description copied from interface: ObserverConfiguration

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

Specified by:

getExcludedPaths in interface ObserverConfiguration

Returns:

A set of excluded paths, might be empty.

getChangeTypes

public Set<ResourceChange.ChangeType> getChangeTypes()

Description copied from interface: ObserverConfiguration

The set of types listeners are interested in.

Specified by:

getChangeTypes in interface ObserverConfiguration

Returns:

Non empty set of types

matches

public boolean matches(String path)

Description copied from interface: ObserverConfiguration

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

Specified by:

matches in interface ObserverConfiguration

Parameters:

path - The path to check

Returns:

true if the path matches the configuration.

getPropertyNamesHint

public Set<String> getPropertyNamesHint()

Description copied from interface: ObserverConfiguration

Set containing the set of property names which serves as an optional hint for the underlying to only report property changes enlisted, ie the underlying might ignore this.

Specified by:

getPropertyNamesHint in interface ObserverConfiguration

Returns:

Set containing the set of property names or null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object