org.apache.zookeeper.AddWatchMode Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.zookeeper;
/**
* Modes available to {@link ZooKeeper#addWatch(String, Watcher, AddWatchMode)}
*/
public enum AddWatchMode {
/**
*
* Set a watcher on the given path that does not get removed when triggered (i.e. it stays active
* until it is removed). This watcher
* is triggered for both data and child events. To remove the watcher, use
* removeWatches() with WatcherType.Any. The watcher behaves as if you placed an exists() watch and
* a getData() watch on the ZNode at the given path.
*
*/
PERSISTENT(ZooDefs.AddWatchModes.persistent),
/**
*
* Set a watcher on the given path that: a) does not get removed when triggered (i.e. it stays active
* until it is removed); b) applies not only to the registered path but all child paths recursively. This watcher
* is triggered for both data and child events. To remove the watcher, use
* removeWatches() with WatcherType.Any
*
*
*
* The watcher behaves as if you placed an exists() watch and
* a getData() watch on the ZNode at the given path and any ZNodes that are children
* of the given path including children added later.
*
*
*
* NOTE: when there are active recursive watches there is a small performance decrease as all segments
* of ZNode paths must be checked for watch triggering.
*
*/
PERSISTENT_RECURSIVE(ZooDefs.AddWatchModes.persistentRecursive)
;
public int getMode() {
return mode;
}
private final int mode;
AddWatchMode(int mode) {
this.mode = mode;
}
}