FileEvents.java

/*
 * Copyright 2012 Adam Murdoch
 *
 *    Licensed 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 net.rubygrapefruit.platform;

import java.io.File;

/**
 * Allows a directory or file to be monitored for changes.
 */
@ThreadSafe
public interface FileEvents extends NativeIntegration {
    /**
     * Starts watching the specified directory or file.
     *
     * <p>Caller should call {@link FileWatch#close()} when finished watching to release any resources.
     *
     * <p>Note: The current implementation does not notify about changes to files in a directory, only the directory
     * itself. This means events will be received when files are created or deleted in the directory, but not when files
     * in the directory are modified.</p>
     */
    FileWatch startWatch(File target) throws NativeException;
}