jetbrains.buildServer.util.browser

Interface Browser

All Known Implementing Classes:

BrowserWithNewRoot, CachingBrowser, FileSystemBrowser, ZipAwareBrowser

public interface Browser

Represents an abstract browser of elements organized in a tree-like structure, e.g. Unix file system browser.

Since:

6.0

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

Method Summary

Modifier and Type	Method and Description
Behaviour	getBehaviour() Returns the browser behaviour options.
Element	getElement(java.lang.String path)
Element	getRoot() Returns the root element.

Method Detail

getRoot

@NotNull
Element getRoot()
                  throws BrowserException

Returns the root element.

Returns:

root element

Throws:

BrowserException - in case of an error

getElement

@Nullable
Element getElement(@NotNull
                             java.lang.String path)
                      throws BrowserException

Parameters:

path - path to some element

Returns:

element for specified path or null if element does not exist

Throws:

BrowserException

getBehaviour

@NotNull
Behaviour getBehaviour()

Returns the browser behaviour options.

For most implementations Behaviour.DEFAULT_BEHAVIOUR is returned.

Returns:

browser behaviour

Since:

7.0