123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="de">
- <head>
- <!-- Generated by javadoc -->
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <title>FileAlterationObserver (Apache Commons IO 2.6 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="FileAlterationObserver (Apache Commons IO 2.6 API)";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
- var tabs = {65535:["t0","All 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/FileAlterationObserver.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/commons/io/monitor/FileAlterationMonitor.html" title="class in org.apache.commons.io.monitor"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../../org/apache/commons/io/monitor/FileEntry.html" title="class in org.apache.commons.io.monitor"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../../index.html?org/apache/commons/io/monitor/FileAlterationObserver.html" target="_top">Frames</a></li>
- <li><a href="FileAlterationObserver.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>Nested | </li>
- <li>Field | </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>Field | </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.commons.io.monitor</div>
- <h2 title="Class FileAlterationObserver" class="title">Class FileAlterationObserver</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li><a href="http://docs.oracle.com/javase/7/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.commons.io.monitor.FileAlterationObserver</li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>All Implemented Interfaces:</dt>
- <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
- </dl>
- <hr>
- <br>
- <pre>public class <span class="typeNameLabel">FileAlterationObserver</span>
- extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
- implements <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
- <div class="block">FileAlterationObserver represents the state of files below a root directory,
- checking the filesystem and notifying listeners of create, change or
- delete events.
- <p>
- To use this implementation:
- <ul>
- <li>Create <a href="../../../../../org/apache/commons/io/monitor/FileAlterationListener.html" title="interface in org.apache.commons.io.monitor"><code>FileAlterationListener</code></a> implementation(s) that process
- the file/directory create, change and delete events</li>
- <li>Register the listener(s) with a <a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html" title="class in org.apache.commons.io.monitor"><code>FileAlterationObserver</code></a> for
- the appropriate directory.</li>
- <li>Either register the observer(s) with a <a href="../../../../../org/apache/commons/io/monitor/FileAlterationMonitor.html" title="class in org.apache.commons.io.monitor"><code>FileAlterationMonitor</code></a> or
- run manually.</li>
- </ul>
- <h2>Basic Usage</h2>
- Create a <a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html" title="class in org.apache.commons.io.monitor"><code>FileAlterationObserver</code></a> for the directory and register the listeners:
- <pre>
- File directory = new File(new File("."), "src");
- FileAlterationObserver observer = new FileAlterationObserver(directory);
- observer.addListener(...);
- observer.addListener(...);
- </pre>
- To manually observe a directory, initialize the observer and invoked the
- <a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html#checkAndNotify--"><code>checkAndNotify()</code></a> method as required:
- <pre>
- // initialize
- observer.init();
- ...
- // invoke as required
- observer.checkAndNotify();
- ...
- observer.checkAndNotify();
- ...
- // finished
- observer.finish();
- </pre>
- Alternatively, register the observer(s) with a <a href="../../../../../org/apache/commons/io/monitor/FileAlterationMonitor.html" title="class in org.apache.commons.io.monitor"><code>FileAlterationMonitor</code></a>,
- which creates a new thread, invoking the observer at the specified interval:
- <pre>
- long interval = ...
- FileAlterationMonitor monitor = new FileAlterationMonitor(interval);
- monitor.addObserver(observer);
- monitor.start();
- ...
- monitor.stop();
- </pre>
- <h2>File Filters</h2>
- This implementation can monitor portions of the file system
- by using <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileFilter.html?is-external=true" title="class or interface in java.io"><code>FileFilter</code></a>s to observe only the files and/or directories
- that are of interest. This makes it more efficient and reduces the
- noise from <i>unwanted</i> file system events.
- <p>
- <a href="http://commons.apache.org/io/">Commons IO</a> has a good range of
- useful, ready made
- <a href="../filefilter/package-summary.html">File Filter</a>
- implementations for this purpose.
- <p>
- For example, to only observe 1) visible directories and 2) files with a ".java" suffix
- in a root directory called "src" you could set up a <a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html" title="class in org.apache.commons.io.monitor"><code>FileAlterationObserver</code></a> in the following
- way:
- <pre>
- // Create a FileFilter
- IOFileFilter directories = FileFilterUtils.and(
- FileFilterUtils.directoryFileFilter(),
- HiddenFileFilter.VISIBLE);
- IOFileFilter files = FileFilterUtils.and(
- FileFilterUtils.fileFileFilter(),
- FileFilterUtils.suffixFileFilter(".java"));
- IOFileFilter filter = FileFilterUtils.or(directories, files);
- // Create the File system observer and register File Listeners
- FileAlterationObserver observer = new FileAlterationObserver(new File("src"), filter);
- observer.addListener(...);
- observer.addListener(...);
- </pre>
- <h2>FileEntry</h2>
- <a href="../../../../../org/apache/commons/io/monitor/FileEntry.html" title="class in org.apache.commons.io.monitor"><code>FileEntry</code></a> represents the state of a file or directory, capturing
- <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> attributes at a point in time. Custom implementations of
- <a href="../../../../../org/apache/commons/io/monitor/FileEntry.html" title="class in org.apache.commons.io.monitor"><code>FileEntry</code></a> can be used to capture additional properties that the
- basic implementation does not support. The <a href="../../../../../org/apache/commons/io/monitor/FileEntry.html#refresh-java.io.File-"><code>FileEntry.refresh(File)</code></a>
- method is used to determine if a file or directory has changed since the last
- check and stores the current state of the <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a>'s properties.</div>
- <dl>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>2.0</dd>
- <dt><span class="simpleTagLabel">Version:</span></dt>
- <dd>$Id$</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../../org/apache/commons/io/monitor/FileAlterationListener.html" title="interface in org.apache.commons.io.monitor"><code>FileAlterationListener</code></a>,
- <a href="../../../../../org/apache/commons/io/monitor/FileAlterationMonitor.html" title="class in org.apache.commons.io.monitor"><code>FileAlterationMonitor</code></a>,
- <a href="../../../../../serialized-form.html#org.apache.commons.io.monitor.FileAlterationObserver">Serialized Form</a></dd>
- </dl>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- ======== 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="colFirst" scope="col">Modifier</th>
- <th class="colLast" scope="col">Constructor and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code> </code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html#FileAlterationObserver-java.io.File-">FileAlterationObserver</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory)</code>
- <div class="block">Construct an observer for the specified directory.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code>protected </code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html#FileAlterationObserver-org.apache.commons.io.monitor.FileEntry-java.io.FileFilter-org.apache.commons.io.IOCase-">FileAlterationObserver</a></span>(<a href="../../../../../org/apache/commons/io/monitor/FileEntry.html" title="class in org.apache.commons.io.monitor">FileEntry</a> rootEntry,
- <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileFilter.html?is-external=true" title="class or interface in java.io">FileFilter</a> fileFilter,
- <a href="../../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a> caseSensitivity)</code>
- <div class="block">Construct an observer for the specified directory, file filter and
- file comparator.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code> </code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html#FileAlterationObserver-java.io.File-java.io.FileFilter-">FileAlterationObserver</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory,
- <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileFilter.html?is-external=true" title="class or interface in java.io">FileFilter</a> fileFilter)</code>
- <div class="block">Construct an observer for the specified directory and file filter.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code> </code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html#FileAlterationObserver-java.io.File-java.io.FileFilter-org.apache.commons.io.IOCase-">FileAlterationObserver</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory,
- <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileFilter.html?is-external=true" title="class or interface in java.io">FileFilter</a> fileFilter,
- <a href="../../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a> caseSensitivity)</code>
- <div class="block">Construct an observer for the specified directory, file filter and
- file comparator.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code> </code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html#FileAlterationObserver-java.lang.String-">FileAlterationObserver</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> directoryName)</code>
- <div class="block">Construct an observer for the specified directory.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colFirst"><code> </code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html#FileAlterationObserver-java.lang.String-java.io.FileFilter-">FileAlterationObserver</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> directoryName,
- <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileFilter.html?is-external=true" title="class or interface in java.io">FileFilter</a> fileFilter)</code>
- <div class="block">Construct an observer for the specified directory and file filter.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code> </code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html#FileAlterationObserver-java.lang.String-java.io.FileFilter-org.apache.commons.io.IOCase-">FileAlterationObserver</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> directoryName,
- <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileFilter.html?is-external=true" title="class or interface in java.io">FileFilter</a> fileFilter,
- <a href="../../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a> caseSensitivity)</code>
- <div class="block">Construct an observer for the specified directory, file filter and
- file comparator.</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="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>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html#addListener-org.apache.commons.io.monitor.FileAlterationListener-">addListener</a></span>(<a href="../../../../../org/apache/commons/io/monitor/FileAlterationListener.html" title="interface in org.apache.commons.io.monitor">FileAlterationListener</a> listener)</code>
- <div class="block">Add a file system listener.</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html#checkAndNotify--">checkAndNotify</a></span>()</code>
- <div class="block">Check whether the file and its children have been created, modified or deleted.</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html#destroy--">destroy</a></span>()</code>
- <div class="block">Final processing.</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html#getDirectory--">getDirectory</a></span>()</code>
- <div class="block">Return the directory being observed.</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileFilter.html?is-external=true" title="class or interface in java.io">FileFilter</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html#getFileFilter--">getFileFilter</a></span>()</code>
- <div class="block">Return the fileFilter.</div>
- </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/commons/io/monitor/FileAlterationListener.html" title="interface in org.apache.commons.io.monitor">FileAlterationListener</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/monitor/FileAlterationObserver.html#getListeners--">getListeners</a></span>()</code>
- <div class="block">Returns the set of registered file system listeners.</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/commons/io/monitor/FileAlterationObserver.html#initialize--">initialize</a></span>()</code>
- <div class="block">Initialize the observer.</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/commons/io/monitor/FileAlterationObserver.html#removeListener-org.apache.commons.io.monitor.FileAlterationListener-">removeListener</a></span>(<a href="../../../../../org/apache/commons/io/monitor/FileAlterationListener.html" title="interface in org.apache.commons.io.monitor">FileAlterationListener</a> listener)</code>
- <div class="block">Remove a file system listener.</div>
- </td>
- </tr>
- <tr id="i8" class="altColor">
- <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/commons/io/monitor/FileAlterationObserver.html#toString--">toString</a></span>()</code>
- <div class="block">Provide a String representation of this observer.</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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
- <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/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">
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a name="FileAlterationObserver-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>FileAlterationObserver</h4>
- <pre>public FileAlterationObserver(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> directoryName)</pre>
- <div class="block">Construct an observer for the specified directory.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>directoryName</code> - the name of the directory to observe</dd>
- </dl>
- </li>
- </ul>
- <a name="FileAlterationObserver-java.lang.String-java.io.FileFilter-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>FileAlterationObserver</h4>
- <pre>public FileAlterationObserver(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> directoryName,
- <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileFilter.html?is-external=true" title="class or interface in java.io">FileFilter</a> fileFilter)</pre>
- <div class="block">Construct an observer for the specified directory and file filter.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>directoryName</code> - the name of the directory to observe</dd>
- <dd><code>fileFilter</code> - The file filter or null if none</dd>
- </dl>
- </li>
- </ul>
- <a name="FileAlterationObserver-java.lang.String-java.io.FileFilter-org.apache.commons.io.IOCase-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>FileAlterationObserver</h4>
- <pre>public FileAlterationObserver(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> directoryName,
- <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileFilter.html?is-external=true" title="class or interface in java.io">FileFilter</a> fileFilter,
- <a href="../../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a> caseSensitivity)</pre>
- <div class="block">Construct an observer for the specified directory, file filter and
- file comparator.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>directoryName</code> - the name of the directory to observe</dd>
- <dd><code>fileFilter</code> - The file filter or null if none</dd>
- <dd><code>caseSensitivity</code> - what case sensitivity to use comparing file names, null means system sensitive</dd>
- </dl>
- </li>
- </ul>
- <a name="FileAlterationObserver-java.io.File-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>FileAlterationObserver</h4>
- <pre>public FileAlterationObserver(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory)</pre>
- <div class="block">Construct an observer for the specified directory.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>directory</code> - the directory to observe</dd>
- </dl>
- </li>
- </ul>
- <a name="FileAlterationObserver-java.io.File-java.io.FileFilter-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>FileAlterationObserver</h4>
- <pre>public FileAlterationObserver(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory,
- <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileFilter.html?is-external=true" title="class or interface in java.io">FileFilter</a> fileFilter)</pre>
- <div class="block">Construct an observer for the specified directory and file filter.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>directory</code> - the directory to observe</dd>
- <dd><code>fileFilter</code> - The file filter or null if none</dd>
- </dl>
- </li>
- </ul>
- <a name="FileAlterationObserver-java.io.File-java.io.FileFilter-org.apache.commons.io.IOCase-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>FileAlterationObserver</h4>
- <pre>public FileAlterationObserver(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory,
- <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileFilter.html?is-external=true" title="class or interface in java.io">FileFilter</a> fileFilter,
- <a href="../../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a> caseSensitivity)</pre>
- <div class="block">Construct an observer for the specified directory, file filter and
- file comparator.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>directory</code> - the directory to observe</dd>
- <dd><code>fileFilter</code> - The file filter or null if none</dd>
- <dd><code>caseSensitivity</code> - what case sensitivity to use comparing file names, null means system sensitive</dd>
- </dl>
- </li>
- </ul>
- <a name="FileAlterationObserver-org.apache.commons.io.monitor.FileEntry-java.io.FileFilter-org.apache.commons.io.IOCase-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>FileAlterationObserver</h4>
- <pre>protected FileAlterationObserver(<a href="../../../../../org/apache/commons/io/monitor/FileEntry.html" title="class in org.apache.commons.io.monitor">FileEntry</a> rootEntry,
- <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileFilter.html?is-external=true" title="class or interface in java.io">FileFilter</a> fileFilter,
- <a href="../../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a> caseSensitivity)</pre>
- <div class="block">Construct an observer for the specified directory, file filter and
- file comparator.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>rootEntry</code> - the root directory to observe</dd>
- <dd><code>fileFilter</code> - The file filter or null if none</dd>
- <dd><code>caseSensitivity</code> - what case sensitivity to use comparing file names, null means system sensitive</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="getDirectory--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getDirectory</h4>
- <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> getDirectory()</pre>
- <div class="block">Return the directory being observed.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>the directory being observed</dd>
- </dl>
- </li>
- </ul>
- <a name="getFileFilter--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getFileFilter</h4>
- <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FileFilter.html?is-external=true" title="class or interface in java.io">FileFilter</a> getFileFilter()</pre>
- <div class="block">Return the fileFilter.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>the fileFilter</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>2.1</dd>
- </dl>
- </li>
- </ul>
- <a name="addListener-org.apache.commons.io.monitor.FileAlterationListener-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>addListener</h4>
- <pre>public void addListener(<a href="../../../../../org/apache/commons/io/monitor/FileAlterationListener.html" title="interface in org.apache.commons.io.monitor">FileAlterationListener</a> listener)</pre>
- <div class="block">Add a file system listener.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>listener</code> - The file system listener</dd>
- </dl>
- </li>
- </ul>
- <a name="removeListener-org.apache.commons.io.monitor.FileAlterationListener-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>removeListener</h4>
- <pre>public void removeListener(<a href="../../../../../org/apache/commons/io/monitor/FileAlterationListener.html" title="interface in org.apache.commons.io.monitor">FileAlterationListener</a> listener)</pre>
- <div class="block">Remove a file system listener.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>listener</code> - The file system listener</dd>
- </dl>
- </li>
- </ul>
- <a name="getListeners--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getListeners</h4>
- <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/commons/io/monitor/FileAlterationListener.html" title="interface in org.apache.commons.io.monitor">FileAlterationListener</a>> getListeners()</pre>
- <div class="block">Returns the set of registered file system listeners.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The file system listeners</dd>
- </dl>
- </li>
- </ul>
- <a name="initialize--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>initialize</h4>
- <pre>public void initialize()
- throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
- <div class="block">Initialize the observer.</div>
- <dl>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if an error occurs</dd>
- </dl>
- </li>
- </ul>
- <a name="destroy--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>destroy</h4>
- <pre>public void destroy()
- throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
- <div class="block">Final processing.</div>
- <dl>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if an error occurs</dd>
- </dl>
- </li>
- </ul>
- <a name="checkAndNotify--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>checkAndNotify</h4>
- <pre>public void checkAndNotify()</pre>
- <div class="block">Check whether the file and its children have been created, modified or deleted.</div>
- </li>
- </ul>
- <a name="toString--">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>toString</h4>
- <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre>
- <div class="block">Provide a String representation of this observer.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>a String representation of this observer</dd>
- </dl>
- </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/FileAlterationObserver.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/commons/io/monitor/FileAlterationMonitor.html" title="class in org.apache.commons.io.monitor"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../../org/apache/commons/io/monitor/FileEntry.html" title="class in org.apache.commons.io.monitor"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../../index.html?org/apache/commons/io/monitor/FileAlterationObserver.html" target="_top">Frames</a></li>
- <li><a href="FileAlterationObserver.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>Nested | </li>
- <li>Field | </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>Field | </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 © 2002–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
- </body>
- </html>
|