FilterPath (Grandparent POM for Apache Lucene Core and Apache Solr 7.7.0 API)

java.lang.Object
- org.apache.lucene.mockfile.FilterPath

All Implemented Interfaces:

java.lang.Comparable<java.nio.file.Path>, java.lang.Iterable<java.nio.file.Path>, java.nio.file.Path, java.nio.file.Watchable
```
public class FilterPath
extends java.lang.Object
implements java.nio.file.Path
```
A FilterPath contains another Path, which it uses as its basic source of data, possibly transforming the data along the way or providing additional functionality.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.nio.file.Path`	`delegate` The underlying `Path` instance.
`protected java.nio.file.FileSystem`	`fileSystem` The parent `FileSystem` for this path.

Constructor Summary

Constructors
Constructor and Description
`FilterPath(java.nio.file.Path delegate, java.nio.file.FileSystem fileSystem)` Construct a `FilterPath` with parent `fileSystem`, based on the specified base path.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(java.nio.file.Path other)`
`boolean`	`endsWith(java.nio.file.Path other)`
`boolean`	`endsWith(java.lang.String other)`
`boolean`	`equals(java.lang.Object obj)`
`java.nio.file.Path`	`getDelegate()` Get the underlying wrapped path.
`java.nio.file.Path`	`getFileName()`
`java.nio.file.FileSystem`	`getFileSystem()`
`java.nio.file.Path`	`getName(int index)`
`int`	`getNameCount()`
`java.nio.file.Path`	`getParent()`
`java.nio.file.Path`	`getRoot()`
`int`	`hashCode()`
`boolean`	`isAbsolute()`
`java.util.Iterator<java.nio.file.Path>`	`iterator()`
`java.nio.file.Path`	`normalize()`
`java.nio.file.WatchKey`	`register(java.nio.file.WatchService watcher, java.nio.file.WatchEvent.Kind<?>... events)`
`java.nio.file.WatchKey`	`register(java.nio.file.WatchService watcher, java.nio.file.WatchEvent.Kind<?>[] events, java.nio.file.WatchEvent.Modifier... modifiers)`
`java.nio.file.Path`	`relativize(java.nio.file.Path other)`
`java.nio.file.Path`	`resolve(java.nio.file.Path other)`
`java.nio.file.Path`	`resolve(java.lang.String other)`
`java.nio.file.Path`	`resolveSibling(java.nio.file.Path other)`
`java.nio.file.Path`	`resolveSibling(java.lang.String other)`
`boolean`	`startsWith(java.nio.file.Path other)`
`boolean`	`startsWith(java.lang.String other)`
`java.nio.file.Path`	`subpath(int beginIndex, int endIndex)`
`java.nio.file.Path`	`toAbsolutePath()`
`protected java.nio.file.Path`	`toDelegate(java.nio.file.Path path)` Override this to customize the unboxing of Path from various operations
`java.io.File`	`toFile()`
`java.nio.file.Path`	`toRealPath(java.nio.file.LinkOption... options)`
`java.lang.String`	`toString()`
`java.net.URI`	`toUri()`
`static java.nio.file.Path`	`unwrap(java.nio.file.Path path)` Unwraps all `FilterPath`s, returning the innermost `Path`.
`protected java.nio.file.Path`	`wrap(java.nio.file.Path other)` Override this to customize the return wrapped path from various operations

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - delegate
```
protected final java.nio.file.Path delegate
```
    The underlying Path instance.
  - fileSystem
```
protected final java.nio.file.FileSystem fileSystem
```
    The parent FileSystem for this path.
- Constructor Detail
  - FilterPath
```
public FilterPath(java.nio.file.Path delegate,
                  java.nio.file.FileSystem fileSystem)
```
    Construct a FilterPath with parent fileSystem, based on the specified base path.
    
    Parameters:
    
    delegate - specified base path.
    
    fileSystem - parent fileSystem.
- Method Detail
  - getDelegate
```
public java.nio.file.Path getDelegate()
```
    Get the underlying wrapped path.
    
    Returns:
    
    wrapped path.
  - getFileSystem
```
public java.nio.file.FileSystem getFileSystem()
```
    Specified by:
    
    getFileSystem in interface java.nio.file.Path
  - isAbsolute
```
public boolean isAbsolute()
```
    Specified by:
    
    isAbsolute in interface java.nio.file.Path
  - getRoot
```
public java.nio.file.Path getRoot()
```
    Specified by:
    
    getRoot in interface java.nio.file.Path
  - getFileName
```
public java.nio.file.Path getFileName()
```
    Specified by:
    
    getFileName in interface java.nio.file.Path
  - getParent
```
public java.nio.file.Path getParent()
```
    Specified by:
    
    getParent in interface java.nio.file.Path
  - getNameCount
```
public int getNameCount()
```
    Specified by:
    
    getNameCount in interface java.nio.file.Path
  - getName
```
public java.nio.file.Path getName(int index)
```
    Specified by:
    
    getName in interface java.nio.file.Path
  - subpath
```
public java.nio.file.Path subpath(int beginIndex,
                                  int endIndex)
```
    Specified by:
    
    subpath in interface java.nio.file.Path
  - startsWith
```
public boolean startsWith(java.nio.file.Path other)
```
    Specified by:
    
    startsWith in interface java.nio.file.Path
  - startsWith
```
public boolean startsWith(java.lang.String other)
```
    Specified by:
    
    startsWith in interface java.nio.file.Path
  - endsWith
```
public boolean endsWith(java.nio.file.Path other)
```
    Specified by:
    
    endsWith in interface java.nio.file.Path
  - endsWith
```
public boolean endsWith(java.lang.String other)
```
    Specified by:
    
    endsWith in interface java.nio.file.Path
  - normalize
```
public java.nio.file.Path normalize()
```
    Specified by:
    
    normalize in interface java.nio.file.Path
  - resolve
```
public java.nio.file.Path resolve(java.nio.file.Path other)
```
    Specified by:
    
    resolve in interface java.nio.file.Path
  - resolve
```
public java.nio.file.Path resolve(java.lang.String other)
```
    Specified by:
    
    resolve in interface java.nio.file.Path
  - resolveSibling
```
public java.nio.file.Path resolveSibling(java.nio.file.Path other)
```
    Specified by:
    
    resolveSibling in interface java.nio.file.Path
  - resolveSibling
```
public java.nio.file.Path resolveSibling(java.lang.String other)
```
    Specified by:
    
    resolveSibling in interface java.nio.file.Path
  - relativize
```
public java.nio.file.Path relativize(java.nio.file.Path other)
```
    Specified by:
    
    relativize in interface java.nio.file.Path
  - toUri
```
public java.net.URI toUri()
```
    Specified by:
    
    toUri in interface java.nio.file.Path
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface java.nio.file.Path
    
    Overrides:
    
    toString in class java.lang.Object
  - toAbsolutePath
```
public java.nio.file.Path toAbsolutePath()
```
    Specified by:
    
    toAbsolutePath in interface java.nio.file.Path
  - toRealPath
```
public java.nio.file.Path toRealPath(java.nio.file.LinkOption... options)
                              throws java.io.IOException
```
    Specified by:
    
    toRealPath in interface java.nio.file.Path
    
    Throws:
    
    java.io.IOException
  - toFile
```
public java.io.File toFile()
```
    Specified by:
    
    toFile in interface java.nio.file.Path
  - register
```
public java.nio.file.WatchKey register(java.nio.file.WatchService watcher,
                                       java.nio.file.WatchEvent.Kind<?>[] events,
                                       java.nio.file.WatchEvent.Modifier... modifiers)
                                throws java.io.IOException
```
    Specified by:
    
    register in interface java.nio.file.Path
    
    Specified by:
    
    register in interface java.nio.file.Watchable
    
    Throws:
    
    java.io.IOException
  - register
```
public java.nio.file.WatchKey register(java.nio.file.WatchService watcher,
                                       java.nio.file.WatchEvent.Kind<?>... events)
                                throws java.io.IOException
```
    Specified by:
    
    register in interface java.nio.file.Path
    
    Specified by:
    
    register in interface java.nio.file.Watchable
    
    Throws:
    
    java.io.IOException
  - iterator
```
public java.util.Iterator<java.nio.file.Path> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<java.nio.file.Path>
    
    Specified by:
    
    iterator in interface java.nio.file.Path
  - compareTo
```
public int compareTo(java.nio.file.Path other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<java.nio.file.Path>
    
    Specified by:
    
    compareTo in interface java.nio.file.Path
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.nio.file.Path
    
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Specified by:
    
    equals in interface java.nio.file.Path
    
    Overrides:
    
    equals in class java.lang.Object
  - unwrap
```
public static java.nio.file.Path unwrap(java.nio.file.Path path)
```
    Unwraps all FilterPaths, returning the innermost Path.
    WARNING: this is exposed for testing only!
    
    Parameters:
    
    path - specified path.
    
    Returns:
    
    innermost Path instance
  - wrap
```
protected java.nio.file.Path wrap(java.nio.file.Path other)
```
    Override this to customize the return wrapped path from various operations
  - toDelegate
```
protected java.nio.file.Path toDelegate(java.nio.file.Path path)
```
    Override this to customize the unboxing of Path from various operations

Class FilterPath

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

delegate

fileSystem

Constructor Detail

FilterPath

Method Detail

getDelegate

getFileSystem

isAbsolute

getRoot

getFileName

getParent

getNameCount

getName

subpath

startsWith

startsWith

endsWith

endsWith

normalize

resolve

resolve

resolveSibling

resolveSibling

relativize

toUri

toString

toAbsolutePath

toRealPath

toFile

register

register

iterator

compareTo

hashCode

equals

unwrap

wrap

toDelegate