jpathwatch-java.src.name.pachler.nio.file.FileSystem Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jpathwatch Show documentation

jpathwatch is a Java library for monitoring directories for changes. It uses the host platform's native OS functions to achive this to avoid polling.

The newest version!

/*
 * Copyright 2008-2011 Uwe Pachler
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation. This particular file is
 * subject to the "Classpath" exception as provided in the LICENSE file
 * that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 */

package name.pachler.nio.file;

/**
 * Represents a file system. Use this class to instantiate a new
 * {@link WatchService} in a way that is source compatible with JDK7. An
 * alternative is to use
 * {@link name.pachler.nio.file.ext.Bootstrapper#newWatchService()}.
 *
 * @author count
 */
public abstract class FileSystem {

	// package-private constructor
	FileSystem(){
	}

	/**
	 * Creates a new {@link WatchService} instance by selecting
	 * an implementation that best fits the current platform.

	 * Note that a watch service consumes valuable system resources.
	 * Make sure that to call WatchService.close() when you don't need it any
	 * longer; with many instances failure to do so may result in the system running out of
	 * file descriptors and degraded performance. Typically, you'll only
	 * need one such instance.
	 * @return a new watch service instance.
	 */
	public abstract WatchService newWatchService();
}