FileSystemBrowser (javadoc 2024.12-174331 API)

java.lang.Object
- jetbrains.buildServer.util.browser.FileSystemBrowser

All Implemented Interfaces:

Browser
```
public class FileSystemBrowser
extends Object
implements Browser
```
A simple file system implementation of a browser. Files are terminal elements and directories are non-terminal ones. Directories return first inner directories, then files (both in lexicographical order) as children.

Since:

6.0

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class FileSystemBrowser.DirectoryElement

static class FileSystemBrowser.FileElement

Constructor Summary

Constructors
Constructor Description

FileSystemBrowser(File root)

FileSystemBrowser(String rootPath)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static int`	`fileReadBufferSize(File file)`
`Behaviour`	`getBehaviour()`	Returns the browser behaviour options.
`Element`	`getElement(String path)`
`Element`	`getRoot()`	Returns the root element.

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

- Constructor Detail
  - FileSystemBrowser
```
public FileSystemBrowser(@NotNull
                         File root)
```
  - FileSystemBrowser
```
public FileSystemBrowser(@NotNull
                         String rootPath)
```
- Method Detail
  - getRoot
```
@NotNull
public Element getRoot()
```
    Description copied from interface: Browser
    
    Returns the root element.
    
    Specified by:
    
    getRoot in interface Browser
    
    Returns:
    
    root element
  - getElement
```
@Nullable
public Element getElement(@NotNull
                          String path)
```
    Specified by:
    
    getElement in interface Browser
    
    Parameters:
    
    path - path to some element
    
    Returns:
    
    element for specified path or null if element does not exist
  - getBehaviour
```
@NotNull
public Behaviour getBehaviour()
```
    Description copied from interface: Browser
    
    Returns the browser behaviour options.
    For most implementations Behaviour.DEFAULT_BEHAVIOUR is returned.
    
    Specified by:
    
    getBehaviour in interface Browser
    
    Returns:
    
    browser behaviour
  - fileReadBufferSize
```
public static int fileReadBufferSize(@NotNull
                                     File file)
```