PathWatcher.Config (Jetty :: Utilities 9.3.25.v20180904 API)

java.lang.Object
- org.eclipse.jetty.util.PathWatcher.Config

Enclosing class:: PathWatcher

public static class PathWatcher.Config
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.nio.file.Path`	`dir`
`protected boolean`	`excludeHidden`
`protected java.util.List<java.nio.file.PathMatcher>`	`excludes`
`protected java.util.List<java.nio.file.PathMatcher>`	`includes`
`protected int`	`recurseDepth`
`static int`	`UNLIMITED_DEPTH`

Constructor Summary

Constructors
Constructor Description

Config(java.nio.file.Path path)

Constructors
Constructor	Description
`Config(java.nio.file.Path path)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addExclude(java.lang.String syntaxAndPattern)`	Add an exclude PathMatcher.
`void`	`addExclude(java.nio.file.PathMatcher matcher)`	Add an exclude PathMatcher
`void`	`addExcludeGlobRelative(java.lang.String pattern)`	Add a `glob:` syntax pattern exclude reference in a directory relative, os neutral, pattern.
`void`	`addExcludeHidden()`	Exclude hidden files and hidden directories
`void`	`addExcludes(java.util.List<java.lang.String> syntaxAndPatterns)`	Add multiple exclude PathMatchers
`void`	`addInclude(java.lang.String syntaxAndPattern)`	Add an include PathMatcher
`void`	`addInclude(java.nio.file.PathMatcher matcher)`	Add an include PathMatcher
`void`	`addIncludeGlobRelative(java.lang.String pattern)`	Add a `glob:` syntax pattern reference in a directory relative, os neutral, pattern.
`void`	`addIncludes(java.util.List<java.lang.String> syntaxAndPatterns)`	Add multiple include PathMatchers
`PathWatcher.Config`	`asSubConfig(java.nio.file.Path dir)`	Build a new config from a this configuration.
`java.nio.file.Path`	`getPath()`
`int`	`getRecurseDepth()`
`boolean`	`isExcluded(java.nio.file.Path dir)`
`boolean`	`isIncluded(java.nio.file.Path dir)`
`boolean`	`isRecurseDepthUnlimited()`
`boolean`	`matches(java.nio.file.Path path)`
`void`	`setRecurseDepth(int depth)`	Set the recurse depth for the directory scanning.
`boolean`	`shouldRecurseDirectory(java.nio.file.Path child)`	Determine if the provided child directory should be recursed into based on the configured `setRecurseDepth(int)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - UNLIMITED_DEPTH
```
public static final int UNLIMITED_DEPTH
```
    See Also:
    
    Constant Field Values
  - dir
```
protected final java.nio.file.Path dir
```
  - recurseDepth
```
protected int recurseDepth
```
  - includes
```
protected java.util.List<java.nio.file.PathMatcher> includes
```
  - excludes
```
protected java.util.List<java.nio.file.PathMatcher> excludes
```
  - excludeHidden
```
protected boolean excludeHidden
```
- Constructor Detail
  - Config
```
public Config(java.nio.file.Path path)
```
- Method Detail
  - addExclude
```
public void addExclude(java.nio.file.PathMatcher matcher)
```
    Add an exclude PathMatcher
    
    Parameters:
    
    matcher - the path matcher for this exclude
  - addExclude
```
public void addExclude(java.lang.String syntaxAndPattern)
```
    Add an exclude PathMatcher.
    Note: this pattern is FileSystem specific (so use "/" for Linux and OSX, and "\\" for Windows)
    
    Parameters:
    
    syntaxAndPattern - the PathMatcher syntax and pattern to use
    
    See Also:
    
    for detail on syntax and pattern
  - addExcludeGlobRelative
```
public void addExcludeGlobRelative(java.lang.String pattern)
```
    Add a glob: syntax pattern exclude reference in a directory relative, os neutral, pattern.
```
    On Linux:
    Config config = new Config(Path("/home/user/example"));
    config.addExcludeGlobRelative("*.war") => "glob:/home/user/example/*.war"
 
    On Windows
    Config config = new Config(Path("D:/code/examples"));
    config.addExcludeGlobRelative("*.war") => "glob:D:\\code\\examples\\*.war"

 
```
    Parameters:
    
    pattern - the pattern, in unixy format, relative to config.dir
  - addExcludeHidden
```
public void addExcludeHidden()
```
    Exclude hidden files and hidden directories
  - addExcludes
```
public void addExcludes(java.util.List<java.lang.String> syntaxAndPatterns)
```
    Add multiple exclude PathMatchers
    
    Parameters:
    
    syntaxAndPatterns - the list of PathMatcher syntax and patterns to use
    
    See Also:
    
    for detail on syntax and pattern
  - addInclude
```
public void addInclude(java.nio.file.PathMatcher matcher)
```
    Add an include PathMatcher
    
    Parameters:
    
    matcher - the path matcher for this include
  - addInclude
```
public void addInclude(java.lang.String syntaxAndPattern)
```
    Add an include PathMatcher
    
    Parameters:
    
    syntaxAndPattern - the PathMatcher syntax and pattern to use
    
    See Also:
    
    for detail on syntax and pattern
  - addIncludeGlobRelative
```
public void addIncludeGlobRelative(java.lang.String pattern)
```
    Add a glob: syntax pattern reference in a directory relative, os neutral, pattern.
```
    On Linux:
    Config config = new Config(Path("/home/user/example"));
    config.addIncludeGlobRelative("*.war") => "glob:/home/user/example/*.war"
 
    On Windows
    Config config = new Config(Path("D:/code/examples"));
    config.addIncludeGlobRelative("*.war") => "glob:D:\\code\\examples\\*.war"

 
```
    Parameters:
    
    pattern - the pattern, in unixy format, relative to config.dir
  - addIncludes
```
public void addIncludes(java.util.List<java.lang.String> syntaxAndPatterns)
```
    Add multiple include PathMatchers
    
    Parameters:
    
    syntaxAndPatterns - the list of PathMatcher syntax and patterns to use
    
    See Also:
    
    for detail on syntax and pattern
  - asSubConfig
```
public PathWatcher.Config asSubConfig(java.nio.file.Path dir)
```
    Build a new config from a this configuration.
    Useful for working with sub-directories that also need to be watched.
    
    Parameters:
    
    dir - the directory to build new Config from (using this config as source of includes/excludes)
    
    Returns:
    
    the new Config
  - getRecurseDepth
```
public int getRecurseDepth()
```
  - isRecurseDepthUnlimited
```
public boolean isRecurseDepthUnlimited()
```
  - getPath
```
public java.nio.file.Path getPath()
```
  - isExcluded
```
public boolean isExcluded(java.nio.file.Path dir)
                   throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - isIncluded
```
public boolean isIncluded(java.nio.file.Path dir)
```
  - matches
```
public boolean matches(java.nio.file.Path path)
```
  - setRecurseDepth
```
public void setRecurseDepth(int depth)
```
    Set the recurse depth for the directory scanning.
    -999 indicates arbitrarily deep recursion, 0 indicates no recursion, 1 is only one directory deep, and so on.
    
    Parameters:
    
    depth - the number of directories deep to recurse
  - shouldRecurseDirectory
```
public boolean shouldRecurseDirectory(java.nio.file.Path child)
```
    Determine if the provided child directory should be recursed into based on the configured setRecurseDepth(int)
    
    Parameters:
    
    child - the child directory to test against
    
    Returns:
    
    true if recurse should occur, false otherwise
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class PathWatcher.Config

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNLIMITED_DEPTH

dir

recurseDepth

includes

excludes

excludeHidden

Constructor Detail

Config

Method Detail

addExclude

addExclude

addExcludeGlobRelative

addExcludeHidden

addExcludes

addInclude

addInclude

addIncludeGlobRelative

addIncludes

asSubConfig

getRecurseDepth

isRecurseDepthUnlimited

getPath

isExcluded

isIncluded

matches

setRecurseDepth

shouldRecurseDirectory

toString