org.gradle.internal.nativeplatform.filesystem

Interface FileSystem

public interface FileSystem

A file system accessible to Gradle.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DIR_MODE Default Unix permissions for directories, 755.
static int	DEFAULT_FILE_MODE Default Unix permissions for files, 644.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canCreateSymbolicLink() Tells if the file system can create symbolic links.
void	chmod(java.io.File file, int mode) Changes the Unix permissions of a provided file.
void	createSymbolicLink(java.io.File link, java.io.File target) Creates a symbolic link to a target file.
int	getUnixMode(java.io.File file) Returns the Unix permissions for a provided file.
boolean	isCaseSensitive() Tells whether the file system is case sensitive.
boolean	tryCreateSymbolicLink(java.io.File link, java.io.File target) Tries to create a symbolic link to a target file.

Field Detail

DEFAULT_DIR_MODE

static final int DEFAULT_DIR_MODE

Default Unix permissions for directories, 755.

See Also:

Constant Field Values

DEFAULT_FILE_MODE

static final int DEFAULT_FILE_MODE

Default Unix permissions for files, 644.

See Also:

Constant Field Values

Method Detail

isCaseSensitive

boolean isCaseSensitive()

Tells whether the file system is case sensitive.

Returns:

true if the file system is case sensitive, false otherwise

canCreateSymbolicLink

boolean canCreateSymbolicLink()

Tells if the file system can create symbolic links. If the answer cannot be determined accurately, false is returned.

Returns:

true if the file system can create symbolic links, false otherwise

createSymbolicLink

void createSymbolicLink(java.io.File link,
                      java.io.File target)
                        throws java.io.IOException

Creates a symbolic link to a target file.

Parameters:

link - the link to be created

target - the file to link to

Throws:

java.io.IOException - if the operation fails

tryCreateSymbolicLink

boolean tryCreateSymbolicLink(java.io.File link,
                            java.io.File target)

Tries to create a symbolic link to a target file.

Parameters:

link - the link to be created

target - the file to link to

Returns:

true if the operation was successful, false otherwise

getUnixMode

int getUnixMode(java.io.File file)
                throws java.io.IOException

Returns the Unix permissions for a provided file. Some file systems may not support Unix permissions, in which case sensible default values are returned instead.

Parameters:

file - the file to read permissions from

Returns:

the file's Unix permissions, e.g. 0755

Throws:

java.io.FileNotFoundException - if file doesn't exist

java.io.IOException - if the permissions can't be read

See Also:

DEFAULT_DIR_MODE, DEFAULT_FILE_MODE

chmod

void chmod(java.io.File file,
         int mode)
           throws java.io.IOException

Changes the Unix permissions of a provided file. Implementations that don't support Unix permissions may choose to ignore this request.

Parameters:

file - the file to change permissions on

mode - the permissions, e.g. 0755

Throws:

java.io.FileNotFoundException - if file doesn't exist

java.io.IOException - if the permissions can't be changed