org.eclipse.jgit.util

Class FS_Win32

java.lang.Object

org.eclipse.jgit.util.FS

org.eclipse.jgit.util.FS_Win32

Direct Known Subclasses:

FS_Win32_Cygwin

public class FS_Win32
extends FS

FS implementation for Windows

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jgit.util.FS

FS.Attributes, FS.FSFactory

Field Summary

Fields inherited from class org.eclipse.jgit.util.FS

DETECTED

Constructor Summary

Constructors

Modifier	Constructor and Description
	FS_Win32() Constructor
protected	FS_Win32(FS src) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canExecute(File f) Determine if the file is executable (or not).
void	createSymLink(File path, String target) Create a symbolic link
void	delete(File path) Delete a file.
protected File	discoverGitExe()
boolean	exists(File path) Tests if the path exists, in case of a symbolic link, true even if the target does not exist
FS.Attributes	getAttributes(File path)
boolean	isCaseSensitive() Is this file system case sensitive
boolean	isDirectory(File path) Check if path is a directory.
boolean	isFile(File path) Examine if path represents a regular file.
boolean	isHidden(File path)
boolean	isSymLink(File path)
long	lastModified(File path) Get the last modified time of a file system object.
long	length(File f) Get the length of a file or link, If the OS/JRE supports symbolic links it's the length of the link, else the length of the target.
FS	newInstance()
String	readSymLink(File path) Check if a file is a symbolic link and read it
boolean	retryFailedLockFileCommit() Does this file system have problems with atomic renames?
ProcessBuilder	runInShell(String cmd, String[] args) Initialize a ProcessBuilder to run a command using the system shell.
boolean	setExecute(File f, boolean canExec) Set a file to be executable by the user.
void	setHidden(File path, boolean hidden) Set the hidden attribute for file whose name starts with a period.
void	setLastModified(File path, long time) Set the last modified time of a file system object.
boolean	supportsExecute() Does this operating system and JRE support the execute flag on files?
boolean	supportsSymlinks() Does this operating system and JRE supports symbolic links.
protected File	userHomeImpl() Determine the user's home directory (location where preferences are).

Methods inherited from class org.eclipse.jgit.util.FS

detect, detect, discoverGitSystemConfig, findHook, getGitSystemConfig, internalRunHookIfPresent, normalize, normalize, readPipe, readPipe, relativize, resolve, resolveGrandparentFile, runHookIfPresent, runHookIfPresent, runProcess, searchPath, setGitSystemConfig, setUserHome, userHome

Methods inherited from class java.lang.Object

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

Constructor Detail

FS_Win32

public FS_Win32()

Constructor

FS_Win32

protected FS_Win32(FS src)

Constructor

Parameters:

src - instance whose attributes to copy

Method Detail

newInstance

public FS newInstance()

Specified by:

newInstance in class FS

Returns:

a new instance of the same type of FS.

supportsExecute

public boolean supportsExecute()

Description copied from class: FS

Does this operating system and JRE support the execute flag on files?

Specified by:

supportsExecute in class FS

Returns:

true if this implementation can provide reasonably accurate executable bit information; false otherwise.

canExecute

public boolean canExecute(File f)

Description copied from class: FS

Determine if the file is executable (or not).

Not all platforms and JREs support executable flags on files. If the feature is unsupported this method will always return false.

If the platform supports symbolic links and f is a symbolic link this method returns false, rather than the state of the executable flags on the target file.

Specified by:

canExecute in class FS

Parameters:

f - abstract path to test.

Returns:

true if the file is believed to be executable by the user.

setExecute

public boolean setExecute(File f,
                 boolean canExec)

Description copied from class: FS

Set a file to be executable by the user.

Not all platforms and JREs support executable flags on files. If the feature is unsupported this method will always return false and no changes will be made to the file specified.

Specified by:

setExecute in class FS

Parameters:

f - path to modify the executable status of.

canExec - true to enable execution; false to disable it.

Returns:

true if the change succeeded; false otherwise.

isCaseSensitive

public boolean isCaseSensitive()

Description copied from class: FS

Is this file system case sensitive

Specified by:

isCaseSensitive in class FS

Returns:

true if this implementation is case sensitive

retryFailedLockFileCommit

public boolean retryFailedLockFileCommit()

Description copied from class: FS

Does this file system have problems with atomic renames?

Specified by:

retryFailedLockFileCommit in class FS

Returns:

true if the caller should retry a failed rename of a lock file.

discoverGitExe

protected File discoverGitExe()

Specified by:

discoverGitExe in class FS

Returns:

the path to the Git executable or null if it cannot be determined.

userHomeImpl

protected File userHomeImpl()

Description copied from class: FS

Determine the user's home directory (location where preferences are).

Overrides:

userHomeImpl in class FS

Returns:

the user's home directory; null if the user does not have one.

runInShell

public ProcessBuilder runInShell(String cmd,
                        String[] args)

Description copied from class: FS

Initialize a ProcessBuilder to run a command using the system shell.

Specified by:

runInShell in class FS

Parameters:

cmd - command to execute. This string should originate from the end-user, and thus is platform specific.

args - arguments to pass to command. These should be protected from shell evaluation.

Returns:

a partially completed process builder. Caller should finish populating directory, environment, and then start the process.

supportsSymlinks

public boolean supportsSymlinks()

Description copied from class: FS

Does this operating system and JRE supports symbolic links. The capability to handle symbolic links is detected at runtime.

Overrides:

supportsSymlinks in class FS

Returns:

true if symbolic links may be used

isSymLink

public boolean isSymLink(File path)
                  throws IOException

Overrides:

isSymLink in class FS

Returns:

true if the path is a symbolic link (and we support these)

Throws:

IOException

lastModified

public long lastModified(File path)
                  throws IOException

Description copied from class: FS

Get the last modified time of a file system object. If the OS/JRE support symbolic links, the modification time of the link is returned, rather than that of the link target.

Overrides:

lastModified in class FS

Returns:

last modified time of f

Throws:

IOException

setLastModified

public void setLastModified(File path,
                   long time)
                     throws IOException

Description copied from class: FS

Set the last modified time of a file system object. If the OS/JRE support symbolic links, the link is modified, not the target,

Overrides:

setLastModified in class FS

Throws:

IOException

delete

public void delete(File path)
            throws IOException

Description copied from class: FS

Delete a file. Throws an exception if delete fails.

Overrides:

delete in class FS

Throws:

IOException - this may be a Java7 subclass with detailed information

length

public long length(File f)
            throws IOException

Description copied from class: FS

Get the length of a file or link, If the OS/JRE supports symbolic links it's the length of the link, else the length of the target.

Overrides:

length in class FS

Returns:

length of a file

Throws:

IOException

exists

public boolean exists(File path)

Description copied from class: FS

Tests if the path exists, in case of a symbolic link, true even if the target does not exist

Overrides:

exists in class FS

Returns:

true if path exists

isDirectory

public boolean isDirectory(File path)

Description copied from class: FS

Check if path is a directory. If the OS/JRE supports symbolic links and path is a symbolic link to a directory, this method returns false.

Overrides:

isDirectory in class FS

Returns:

true if file is a directory,

isFile

public boolean isFile(File path)

Description copied from class: FS

Examine if path represents a regular file. If the OS/JRE supports symbolic links the test returns false if path represents a symbolic link.

Overrides:

isFile in class FS

Returns:

true if path represents a regular file

isHidden

public boolean isHidden(File path)
                 throws IOException

Overrides:

isHidden in class FS

Returns:

true if path is hidden, either starts with . on unix or has the hidden attribute in windows

Throws:

IOException

setHidden

public void setHidden(File path,
             boolean hidden)
               throws IOException

Description copied from class: FS

Set the hidden attribute for file whose name starts with a period.

Overrides:

setHidden in class FS

Throws:

IOException

readSymLink

public String readSymLink(File path)
                   throws IOException

Description copied from class: FS

Check if a file is a symbolic link and read it

Overrides:

readSymLink in class FS

Returns:

target of link or null

Throws:

IOException

createSymLink

public void createSymLink(File path,
                 String target)
                   throws IOException

Description copied from class: FS

Create a symbolic link

Overrides:

createSymLink in class FS

Throws:

IOException

getAttributes

public FS.Attributes getAttributes(File path)

Overrides:

getAttributes in class FS

Returns:

the file attributes we care for

Since:

3.3