Package jetbrains.buildServer.vcs.browser

Class VcsBrowserFile

java.lang.Object

jetbrains.buildServer.vcs.browser.VcsBrowserFile

All Implemented Interfaces:

Element

public class VcsBrowserFile
extends Object
implements Element

Author:

dmitry.neverov

Constructor Summary

Constructors

Constructor	Description
VcsBrowserFile(Browser browser, VcsFile file)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Browser	getBrowser()
Iterable<Element>	getChildren()	Returns the ordered list of element's children.
String	getFullName()	Returns the unique full name of the element (relative to the root).
InputStream	getInputStream()	Returns the input stream of the element content.
String	getName()	Returns the element's name.
long	getSize()	Returns the size of the element content.
int	hashCode()
boolean	isContentAvailable()	Returns whether the content is available for the element.
boolean	isLeaf()	Returns whether the element is a leaf, i.e.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jetbrains.buildServer.util.browser.Element

getLastModifiedTimestamp

Constructor Detail

VcsBrowserFile

public VcsBrowserFile(@NotNull
                      Browser browser,
                      @NotNull
                      VcsFile file)

Method Detail

getName

@NotNull
public String getName()

Description copied from interface: Element

Returns the element's name.

Specified by:

getName in interface Element

Returns:

name

getFullName

@NotNull
public String getFullName()

Description copied from interface: Element

Returns the unique full name of the element (relative to the root).

Specified by:

getFullName in interface Element

Returns:

full element name

isLeaf

public boolean isLeaf()

Description copied from interface: Element

Returns whether the element is a leaf, i.e. cannot have child nodes.

Specified by:

isLeaf in interface Element

Returns:

true if the element is a leaf

getChildren

public Iterable<Element> getChildren()
                              throws BrowserException

Description copied from interface: Element

Returns the ordered list of element's children. Method should return null for a leaf element, and a not null instance for other elements. List can be empty. All children's names are different.

Specified by:

getChildren in interface Element

Returns:

the list of children, or null

Throws:

BrowserException - in case of an error

isContentAvailable

public boolean isContentAvailable()

Description copied from interface: Element

Returns whether the content is available for the element. The content is usually available for leaf elements and not available for non-leaf ones. If it's not, the call getInputStream() method will result in exception.

Specified by:

isContentAvailable in interface Element

Returns:

true iff the content is available

getInputStream

@NotNull
public InputStream getInputStream()
                           throws IllegalStateException,
                                  IOException,
                                  BrowserException

Description copied from interface: Element

Returns the input stream of the element content. The caller is responsible for closing the stream at the end.

If the content is not available for the element (see Element.isContentAvailable()), an exception is thrown.

Specified by:

getInputStream in interface Element

Returns:

content input stream

Throws:

IllegalStateException - if the content is not available

IOException - if the input cannot be provided due to I/O error

BrowserException - indicates a general error occurred during input stream opening

getSize

public long getSize()
             throws IllegalStateException

Description copied from interface: Element

Returns the size of the element content.

If the content is not available for the element (see Element.isContentAvailable()) or due to performance reasons a negative value may be returned. Though some implementations can provide the content size, while the content is not available.

Specified by:

getSize in interface Element

Returns:

content size or negative value when unavailable

Throws:

IllegalStateException

getBrowser

@NotNull
public Browser getBrowser()

Specified by:

getBrowser in interface Element

Returns:

browser created this element

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object