githubmirror/brackets

src/filesystem/WatchedRoot.js
73 строки3 KB
Randy Edmunds
annotation comment should be before @tag info
08 июн 2014, 23:09
08 июн 2014, 23:090fedbcd
/*
 * Copyright (c) 2013 Adobe Systems Incorporated. All rights reserved.
 *  
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"), 
 * to deal in the Software without restriction, including without limitation 
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 
 * and/or sell copies of the Software, and to permit persons to whom the 
 * Software is furnished to do so, subject to the following conditions:
 *  
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *  
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 * DEALINGS IN THE SOFTWARE.
 * 
 */


/*jslint vars: true, plusplus: true, devel: true, nomen: true, regexp: true, indent: 4, maxerr: 50 */
/*global define */

define(function (require, exports, module) {
    "use strict";
    
    /*
     * Represents file or directory structure watched by the FileSystem. If the
     * entry is a directory, all children (that pass the supplied filter function)
     * are also watched. A WatchedRoot object begins and ends its life in the
     * INACTIVE state. While in the process of starting up watchers, the WatchedRoot
     * is in the STARTING state. When watchers are ready, the WatchedRoot enters
     * the ACTIVE state.
     *
     * See the FileSystem class for more details.
     *
     * @constructor
     * @param {File|Directory} entry 
     * @param {function(string, string):boolean} filter 
     */
    function WatchedRoot(entry, filter) {
        this.entry = entry;
        this.filter = filter;
    }

    // Status constants
    WatchedRoot.INACTIVE = 0;
    WatchedRoot.STARTING = 1;
    WatchedRoot.ACTIVE = 2;

    /**
     * @type {File|Directory}
     */
    WatchedRoot.prototype.entry = null;
    
    /**
     * @type {function(string, string):boolean}
     */
    WatchedRoot.prototype.filter = null;

    /**
     * @type {number}
     */
    WatchedRoot.prototype.status = WatchedRoot.INACTIVE;
    
    
    // Export this class
    module.exports = WatchedRoot;
});