-
Notifications
You must be signed in to change notification settings - Fork 275
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add long-requested ability to configure the polling rate for the Watc…
…hService that Jimfs creates for watching for directory changes. This is done in such a way that it doesn't make it awkward to create a new WatchService implementation in the future. Fixes #14. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=111885937
- Loading branch information
Showing
8 changed files
with
231 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
81 changes: 81 additions & 0 deletions
81
jimfs/src/main/java/com/google/common/jimfs/WatchServiceConfiguration.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| /* | ||
| * Copyright 2016 Google Inc. | ||
| * | ||
| * 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 com.google.common.jimfs; | ||
|
|
||
| import static com.google.common.base.Preconditions.checkArgument; | ||
| import static com.google.common.base.Preconditions.checkNotNull; | ||
| import static java.util.concurrent.TimeUnit.SECONDS; | ||
|
|
||
| import java.nio.file.WatchService; | ||
| import java.util.concurrent.TimeUnit; | ||
|
|
||
| /** | ||
| * Configuration for the {@link WatchService} implementation used by a file system. | ||
| * | ||
| * @author Colin Decker | ||
| * @since 1.1 | ||
| */ | ||
| public abstract class WatchServiceConfiguration { | ||
|
|
||
| /** | ||
| * The default configuration that's used if the user doesn't provide anything more specific. | ||
| */ | ||
| static final WatchServiceConfiguration DEFAULT = polling(5, SECONDS); | ||
|
|
||
| /** | ||
| * Returns a configuration for a {@link WatchService} that polls watched directories for changes | ||
| * every {@code interval} of the given {@code timeUnit} (e.g. every 5 | ||
| * {@link TimeUnit#SECONDS seconds}). | ||
| */ | ||
| public static WatchServiceConfiguration polling(long interval, TimeUnit timeUnit) { | ||
| return new PollingConfig(interval, timeUnit); | ||
| } | ||
|
|
||
| WatchServiceConfiguration() {} | ||
|
|
||
| /** | ||
| * Creates a new {@link AbstractWatchService} implementation. | ||
| */ | ||
| // return type and parameters of this method subject to change if needed for any future | ||
| // implementations | ||
| abstract AbstractWatchService newWatchService(FileSystemView view, PathService pathService); | ||
|
|
||
| /** | ||
| * Implementation for {@link #polling}. | ||
| */ | ||
| private static final class PollingConfig extends WatchServiceConfiguration { | ||
|
|
||
| private final long interval; | ||
| private final TimeUnit timeUnit; | ||
|
|
||
| private PollingConfig(long interval, TimeUnit timeUnit) { | ||
| checkArgument(interval > 0, "interval (%s) must be positive", interval); | ||
| this.interval = interval; | ||
| this.timeUnit = checkNotNull(timeUnit); | ||
| } | ||
|
|
||
| @Override | ||
| AbstractWatchService newWatchService(FileSystemView view, PathService pathService) { | ||
| return new PollingWatchService(view, pathService, view.state(), interval, timeUnit); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return "WatchServiceConfiguration.polling(" + interval + ", " + timeUnit + ")"; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
79 changes: 79 additions & 0 deletions
79
jimfs/src/test/java/com/google/common/jimfs/WatchServiceConfigurationTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| /* | ||
| * Copyright 2016 Google Inc. | ||
| * | ||
| * 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 com.google.common.jimfs; | ||
|
|
||
| import static com.google.common.truth.Truth.assertThat; | ||
| import static java.util.concurrent.TimeUnit.MILLISECONDS; | ||
| import static java.util.concurrent.TimeUnit.SECONDS; | ||
|
|
||
| import com.google.common.truth.Truth; | ||
|
|
||
| import org.junit.After; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.file.WatchService; | ||
| import java.util.concurrent.TimeUnit; | ||
|
|
||
| /** | ||
| * Tests for {@link WatchServiceConfiguration}. | ||
| * | ||
| * @author Colin Decker | ||
| */ | ||
| @RunWith(JUnit4.class) | ||
| public class WatchServiceConfigurationTest { | ||
|
|
||
| private JimfsFileSystem fs; | ||
|
|
||
| @Before | ||
| public void setUp() { | ||
| // kind of putting the cart before the horse maybe, but it's the easiest way to get valid | ||
| // instances of both a FileSystemView and a PathService | ||
| fs = (JimfsFileSystem) Jimfs.newFileSystem(); | ||
| } | ||
|
|
||
| @After | ||
| public void tearDown() throws IOException { | ||
| fs.close(); | ||
| fs = null; | ||
| } | ||
|
|
||
| @Test | ||
| public void testPollingConfig() { | ||
| WatchServiceConfiguration polling = WatchServiceConfiguration.polling(50, MILLISECONDS); | ||
| WatchService watchService = polling.newWatchService(fs.getDefaultView(), fs.getPathService()); | ||
| assertThat(watchService).isInstanceOf(PollingWatchService.class); | ||
|
|
||
| PollingWatchService pollingWatchService = (PollingWatchService) watchService; | ||
| assertThat(pollingWatchService.interval).isEqualTo(50); | ||
| assertThat(pollingWatchService.timeUnit).isEqualTo(MILLISECONDS); | ||
| } | ||
|
|
||
| @Test | ||
| public void testDefaultConfig() { | ||
| WatchService watchService = WatchServiceConfiguration.DEFAULT | ||
| .newWatchService(fs.getDefaultView(), fs.getPathService()); | ||
| assertThat(watchService).isInstanceOf(PollingWatchService.class); | ||
|
|
||
| PollingWatchService pollingWatchService = (PollingWatchService) watchService; | ||
| assertThat(pollingWatchService.interval).isEqualTo(5); | ||
| assertThat(pollingWatchService.timeUnit).isEqualTo(SECONDS); | ||
| } | ||
| } |