org.gradle.api.internal.file

Class DefaultFileTreeElement

java.lang.Object

org.gradle.api.internal.file.AbstractFileTreeElement

org.gradle.api.internal.file.DefaultFileTreeElement

All Implemented Interfaces:

FileTreeElement

public class DefaultFileTreeElement
extends AbstractFileTreeElement

Constructor Summary

Constructors

Constructor and Description
DefaultFileTreeElement(File file, RelativePath relativePath)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayName()
File	getFile() Returns the file being visited.
long	getLastModified() Returns the last modified time of this file.
int	getMode() Returns the Unix permissions of this file, e.g.
RelativePath	getRelativePath() Returns the path of this file, relative to the root of the containing file tree.
long	getSize() Returns the size of this file.
boolean	isDirectory() Returns true if this element is a directory, or false if this element is a regular file.
InputStream	open() Opens this file as an input stream.

Methods inherited from class org.gradle.api.internal.file.AbstractFileTreeElement

copyTo, copyTo, getName, getPath, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultFileTreeElement

public DefaultFileTreeElement(File file,
                      RelativePath relativePath)

Method Detail

getFile

public File getFile()

Description copied from interface: FileTreeElement

Returns the file being visited.

Returns:

The file. Never returns null.

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in class AbstractFileTreeElement

getLastModified

public long getLastModified()

Description copied from interface: FileTreeElement

Returns the last modified time of this file. Generally, calling this method is more performant than calling getFile().lastModified()

Returns:

The last modified time.

getSize

public long getSize()

Description copied from interface: FileTreeElement

Returns the size of this file. Generally, calling this method is more performant than calling getFile().length().

Returns:

The size, in bytes.

isDirectory

public boolean isDirectory()

Description copied from interface: FileTreeElement

Returns true if this element is a directory, or false if this element is a regular file.

Returns:

true if this element is a directory.

open

public InputStream open()

Description copied from interface: FileTreeElement

Opens this file as an input stream. Generally, calling this method is more performant than calling new FileInputStream(getFile()).

Returns:

The input stream. Never returns null. The caller is responsible for closing this stream.

getRelativePath

public RelativePath getRelativePath()

Description copied from interface: FileTreeElement

Returns the path of this file, relative to the root of the containing file tree.

Returns:

The path. Never returns null.

getMode

public int getMode()

Description copied from interface: FileTreeElement

Returns the Unix permissions of this file, e.g. 0644.

Specified by:

getMode in interface FileTreeElement

Overrides:

getMode in class AbstractFileTreeElement

Returns:

The Unix file permissions.