org.gradle.api.internal.file

Class AbstractFileTreeElement

java.lang.Object

org.gradle.api.internal.file.AbstractFileTreeElement

All Implemented Interfaces:

FileTreeElement

Direct Known Subclasses:

DefaultFileTreeElement

public abstract class AbstractFileTreeElement
extends java.lang.Object
implements FileTreeElement

Constructor Summary

Constructors

Constructor and Description
AbstractFileTreeElement()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	copyTo(java.io.File target) Copies this file to the given target file.
void	copyTo(java.io.OutputStream outstr) Copies the content of this file to an output stream.
abstract java.lang.String	getDisplayName()
int	getMode() Returns the Unix permissions of this file, e.g.
java.lang.String	getName() Returns the base name of this file.
java.lang.String	getPath() Returns the path of this file, relative to the root of the containing file tree.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.api.file.FileTreeElement

getFile, getLastModified, getRelativePath, getSize, isDirectory, open

Constructor Detail

AbstractFileTreeElement

public AbstractFileTreeElement()

Method Detail

getDisplayName

public abstract java.lang.String getDisplayName()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()

Description copied from interface: FileTreeElement

Returns the base name of this file.

Specified by:

getName in interface FileTreeElement

Returns:

The name. Never returns null.

getPath

public java.lang.String getPath()

Description copied from interface: FileTreeElement

Returns the path of this file, relative to the root of the containing file tree. Always uses '/' as the hierarchy separator, regardless of platform file separator. Same as calling getRelativePath().getPathString().

Specified by:

getPath in interface FileTreeElement

Returns:

The path. Never returns null.

copyTo

public void copyTo(java.io.OutputStream outstr)

Description copied from interface: FileTreeElement

Copies the content of this file to an output stream. Generally, calling this method is more performant than calling new FileInputStream(getFile()).

Specified by:

copyTo in interface FileTreeElement

Parameters:

outstr - The output stream to write to. The caller is responsible for closing this stream.

copyTo

public boolean copyTo(java.io.File target)

Description copied from interface: FileTreeElement

Copies this file to the given target file. Does not copy the file if the target is already a copy of this file.

Specified by:

copyTo in interface FileTreeElement

Parameters:

target - the target file.

Returns:

true if this file was copied, false if it was up-to-date

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

Returns:

The Unix file permissions.