| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>FileChangeWatcher (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FileChangeWatcher (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FileChangeWatcher.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/io/DelegatingInputStream.html" title="class in org.apache.hadoop.hbase.io"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/io/FileChangeWatcher.html" target="_top">Frames</a></li> |
| <li><a href="FileChangeWatcher.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.hbase.io</div> |
| <h2 title="Class FileChangeWatcher" class="title">Class FileChangeWatcher</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.hbase.io.FileChangeWatcher</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Private |
| public final class <a href="../../../../../src-html/org/apache/hadoop/hbase/io/FileChangeWatcher.html#line.50">FileChangeWatcher</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Instances of this class can be used to watch a directory for file changes. When a file is added |
| to, deleted from, or is modified in the given directory, the callback provided by the user will |
| be called from a background thread. Some things to keep in mind: |
| <ul> |
| <li>The callback should be thread-safe.</li> |
| <li>Changes that happen around the time the thread is started may be missed.</li> |
| <li>There is a delay between a file changing and the callback firing.</li> |
| <li>The watch is not recursive - changes to subdirectories will not trigger a callback.</li> |
| </ul> |
| <p/> |
| This file has been copied from the Apache ZooKeeper project.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href= |
| "https://github.com/apache/zookeeper/blob/8148f966947d3ecf3db0b756d93c9ffa88174af9/zookeeper-server/src/main/java/org/apache/zookeeper/common/FileChangeWatcher.java">Base |
| revision</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.WatcherThread.html" title="class in org.apache.hadoop.hbase.io">FileChangeWatcher.WatcherThread</a></span></code> |
| <div class="block">Inner class that implements the watcher thread logic.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private static org.slf4j.Logger</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.html#LOG">LOG</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.html#state">state</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.WatcherThread.html" title="class in org.apache.hadoop.hbase.io">FileChangeWatcher.WatcherThread</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.html#watcherThread">watcherThread</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.html#FileChangeWatcher-java.nio.file.Path-java.lang.String-java.util.function.Consumer-">FileChangeWatcher</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a> dirPath, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> threadNameSuffix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/WatchEvent.html?is-external=true" title="class or interface in java.nio.file">WatchEvent</a><?>> callback)</code> |
| <div class="block">Creates a watcher that watches <code>dirPath</code> and invokes <code>callback</code> on |
| changes.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>private boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.html#compareAndSetState-org.apache.hadoop.hbase.io.FileChangeWatcher.State:A-org.apache.hadoop.hbase.io.FileChangeWatcher.State-">compareAndSetState</a></span>(<a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a>[] expectedStates, |
| <a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a> update)</code> |
| <div class="block">Atomically sets the state to <code>update</code> if and only if the state is currently one of |
| <code>expectedStates</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>private boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.html#compareAndSetState-org.apache.hadoop.hbase.io.FileChangeWatcher.State-org.apache.hadoop.hbase.io.FileChangeWatcher.State-">compareAndSetState</a></span>(<a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a> expected, |
| <a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a> update)</code> |
| <div class="block">Atomically sets the state to <code>update</code> if and only if the state is currently |
| <code>expected</code>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.html#getState--">getState</a></span>()</code> |
| <div class="block">Returns the current <a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io"><code>FileChangeWatcher.State</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>(package private) <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.html#getWatcherThreadName--">getWatcherThreadName</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>private static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.html#handleException-java.lang.Thread-java.lang.Throwable-">handleException</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang">Thread</a> thread, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> e)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>private void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.html#setState-org.apache.hadoop.hbase.io.FileChangeWatcher.State-">setState</a></span>(<a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a> newState)</code> |
| <div class="block">Sets the state to <code>newState</code>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.html#start--">start</a></span>()</code> |
| <div class="block">Tells the background thread to start.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.html#stop--">stop</a></span>()</code> |
| <div class="block">Tells the background thread to stop.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>(package private) void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.html#waitForState-org.apache.hadoop.hbase.io.FileChangeWatcher.State-">waitForState</a></span>(<a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a> desiredState)</code> |
| <div class="block">Blocks until the current state becomes <code>desiredState</code>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="LOG"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOG</h4> |
| <pre>private static final org.slf4j.Logger <a href="../../../../../src-html/org/apache/hadoop/hbase/io/FileChangeWatcher.html#line.52">LOG</a></pre> |
| </li> |
| </ul> |
| <a name="watcherThread"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>watcherThread</h4> |
| <pre>private final <a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.WatcherThread.html" title="class in org.apache.hadoop.hbase.io">FileChangeWatcher.WatcherThread</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/io/FileChangeWatcher.html#line.62">watcherThread</a></pre> |
| </li> |
| </ul> |
| <a name="state"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>state</h4> |
| <pre>private <a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/io/FileChangeWatcher.html#line.63">state</a></pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="FileChangeWatcher-java.nio.file.Path-java.lang.String-java.util.function.Consumer-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FileChangeWatcher</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/io/FileChangeWatcher.html#line.74">FileChangeWatcher</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a> dirPath, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> threadNameSuffix, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/WatchEvent.html?is-external=true" title="class or interface in java.nio.file">WatchEvent</a><?>> callback) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Creates a watcher that watches <code>dirPath</code> and invokes <code>callback</code> on |
| changes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dirPath</code> - the directory to watch.</dd> |
| <dd><code>callback</code> - the callback to invoke with events. <code>event.kind()</code> will return the |
| type of event, and <code>event.context()</code> will return the filename |
| relative to <code>dirPath</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if there is an error creating the WatchService.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getState--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getState</h4> |
| <pre>public <a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/io/FileChangeWatcher.html#line.94">getState</a>()</pre> |
| <div class="block">Returns the current <a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io"><code>FileChangeWatcher.State</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current state.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForState-org.apache.hadoop.hbase.io.FileChangeWatcher.State-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitForState</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/io/FileChangeWatcher.html#line.104">waitForState</a>(<a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a> desiredState) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre> |
| <div class="block">Blocks until the current state becomes <code>desiredState</code>. Currently only used by tests, |
| thus package-private.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>desiredState</code> - the desired state.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - if the current thread gets interrupted.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setState-org.apache.hadoop.hbase.io.FileChangeWatcher.State-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setState</h4> |
| <pre>private void <a href="../../../../../src-html/org/apache/hadoop/hbase/io/FileChangeWatcher.html#line.114">setState</a>(<a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a> newState)</pre> |
| <div class="block">Sets the state to <code>newState</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newState</code> - the new state.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compareAndSetState-org.apache.hadoop.hbase.io.FileChangeWatcher.State-org.apache.hadoop.hbase.io.FileChangeWatcher.State-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compareAndSetState</h4> |
| <pre>private boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/io/FileChangeWatcher.html#line.127">compareAndSetState</a>(<a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a> expected, |
| <a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a> update)</pre> |
| <div class="block">Atomically sets the state to <code>update</code> if and only if the state is currently |
| <code>expected</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expected</code> - the expected state.</dd> |
| <dd><code>update</code> - the new state.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the update succeeds, or false if the current state does not equal |
| <code>expected</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compareAndSetState-org.apache.hadoop.hbase.io.FileChangeWatcher.State:A-org.apache.hadoop.hbase.io.FileChangeWatcher.State-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compareAndSetState</h4> |
| <pre>private boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/io/FileChangeWatcher.html#line.144">compareAndSetState</a>(<a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a>[] expectedStates, |
| <a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io">FileChangeWatcher.State</a> update)</pre> |
| <div class="block">Atomically sets the state to <code>update</code> if and only if the state is currently one of |
| <code>expectedStates</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expectedStates</code> - the expected states.</dd> |
| <dd><code>update</code> - the new state.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the update succeeds, or false if the current state does not equal any of the |
| <code>expectedStates</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/io/FileChangeWatcher.html#line.158">start</a>()</pre> |
| <div class="block">Tells the background thread to start. Does not wait for it to be running. Calling this method |
| more than once has no effect.</div> |
| </li> |
| </ul> |
| <a name="stop--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/io/FileChangeWatcher.html#line.169">stop</a>()</pre> |
| <div class="block">Tells the background thread to stop. Does not wait for it to exit.</div> |
| </li> |
| </ul> |
| <a name="getWatcherThreadName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWatcherThreadName</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/io/FileChangeWatcher.html#line.175">getWatcherThreadName</a>()</pre> |
| </li> |
| </ul> |
| <a name="handleException-java.lang.Thread-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>handleException</h4> |
| <pre>private static void <a href="../../../../../src-html/org/apache/hadoop/hbase/io/FileChangeWatcher.html#line.179">handleException</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang">Thread</a> thread, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> e)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FileChangeWatcher.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/io/DelegatingInputStream.html" title="class in org.apache.hadoop.hbase.io"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/io/FileChangeWatcher.State.html" title="enum in org.apache.hadoop.hbase.io"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/io/FileChangeWatcher.html" target="_top">Frames</a></li> |
| <li><a href="FileChangeWatcher.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |