/*
 * Copyright 2012-2020 the original author or authors.
 *
 * 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
 *
 *      https://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 org.springframework.boot.devtools.classpath;

import java.net.URL;

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.boot.devtools.filewatch.FileSystemWatcher;
import org.springframework.boot.devtools.filewatch.FileSystemWatcherFactory;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.util.Assert;

Encapsulates a FileSystemWatcher to watch the local classpath directories for changes.
Author:Phillip Webb
See Also:
Since:1.3.0
/** * Encapsulates a {@link FileSystemWatcher} to watch the local classpath directories for * changes. * * @author Phillip Webb * @since 1.3.0 * @see ClassPathFileChangeListener */
public class ClassPathFileSystemWatcher implements InitializingBean, DisposableBean, ApplicationContextAware { private final FileSystemWatcher fileSystemWatcher; private ClassPathRestartStrategy restartStrategy; private ApplicationContext applicationContext; private boolean stopWatcherOnRestart;
Create a new ClassPathFileSystemWatcher instance.
Params:
  • fileSystemWatcherFactory – a factory to create the underlying FileSystemWatcher used to monitor the local file system
  • restartStrategy – the classpath restart strategy
  • urls – the URLs to watch
/** * Create a new {@link ClassPathFileSystemWatcher} instance. * @param fileSystemWatcherFactory a factory to create the underlying * {@link FileSystemWatcher} used to monitor the local file system * @param restartStrategy the classpath restart strategy * @param urls the URLs to watch */
public ClassPathFileSystemWatcher(FileSystemWatcherFactory fileSystemWatcherFactory, ClassPathRestartStrategy restartStrategy, URL[] urls) { Assert.notNull(fileSystemWatcherFactory, "FileSystemWatcherFactory must not be null"); Assert.notNull(urls, "Urls must not be null"); this.fileSystemWatcher = fileSystemWatcherFactory.getFileSystemWatcher(); this.restartStrategy = restartStrategy; this.fileSystemWatcher.addSourceDirectories(new ClassPathDirectories(urls)); }
Set if the FileSystemWatcher should be stopped when a full restart occurs.
Params:
  • stopWatcherOnRestart – if the watcher should be stopped when a restart occurs
/** * Set if the {@link FileSystemWatcher} should be stopped when a full restart occurs. * @param stopWatcherOnRestart if the watcher should be stopped when a restart occurs */
public void setStopWatcherOnRestart(boolean stopWatcherOnRestart) { this.stopWatcherOnRestart = stopWatcherOnRestart; } @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { this.applicationContext = applicationContext; } @Override public void afterPropertiesSet() throws Exception { if (this.restartStrategy != null) { FileSystemWatcher watcherToStop = null; if (this.stopWatcherOnRestart) { watcherToStop = this.fileSystemWatcher; } this.fileSystemWatcher.addListener( new ClassPathFileChangeListener(this.applicationContext, this.restartStrategy, watcherToStop)); } this.fileSystemWatcher.start(); } @Override public void destroy() throws Exception { this.fileSystemWatcher.stop(); } }