FS_POSIX (JGit - Core 4.0.0.201503231230-m1 API)

java.lang.Object
- org.eclipse.jgit.util.FS
- - org.eclipse.jgit.util.FS_POSIX

```
public class FS_POSIX
extends FS
```
Base FS for POSIX based systems

Since:

3.0

Nested Class Summary
- Nested classes/interfaces inherited from class org.eclipse.jgit.util.FS
  FS.Attributes, FS.FSFactory

Field Summary

Fields
Modifier and Type Field and Description

protected static Boolean EXECUTE_FOR_GROUP

protected static Boolean EXECUTE_FOR_OTHERS
- Fields inherited from class org.eclipse.jgit.util.FS
  DETECTED

Fields
Modifier and Type	Field and Description
`protected static Boolean`	`EXECUTE_FOR_GROUP`
`protected static Boolean`	`EXECUTE_FOR_OTHERS`

Constructor Summary

Constructors
Modifier Constructor and Description

protected FS_POSIX()
Default constructor

protected FS_POSIX(FS src)
Constructor

Constructors
Modifier	Constructor and Description
`protected`	`FS_POSIX()` Default constructor
`protected`	`FS_POSIX(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`	`discoverGitPrefix()`
`boolean`	`exists(File path)` Tests if the path exists, in case of a symbolic link, true even if the target does not exist
`File`	`findHook(Repository repository, String hookName)` Tries to find a hook matching the given one in the given repository.
`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.
`protected static Boolean`	`isGranted(PosixFilePermission p, String umask)` Derives requested permission from given octal umask value as defined e.g.
`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()`
`File`	`normalize(File file)` Normalize the unicode path to composed form.
`String`	`normalize(String name)` Normalize the unicode path to composed form.
`String`	`readSymLink(File path)` Check if a file is a symbolic link and read it
`protected static String`	`readUmask()`
`boolean`	`retryFailedLockFileCommit()` Does this file system have problems with atomic renames?
`ProcessResult`	`runHookIfPresent(Repository repository, String hookName, String[] args, PrintStream outRedirect, PrintStream errRedirect, String stdinArgs)` Checks whether the given hook is defined for the given repository, then runs it with the given arguments.
`ProcessBuilder`	`runInShell(String cmd, String[] args)` Initialize a ProcesssBuilder to run a command using the system shell.
`boolean`	`setExecute(File f, boolean canExecute)` 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.

Methods inherited from class org.eclipse.jgit.util.FS
detect, detect, gitPrefix, internalRunHookIfPresent, readPipe, relativize, resolve, runHookIfPresent, runProcess, searchPath, setGitPrefix, setUserHome, userHome, userHomeImpl

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXECUTE_FOR_OTHERS
```
protected static final Boolean EXECUTE_FOR_OTHERS
```
    Since:
    
    4.0
  - EXECUTE_FOR_GROUP
```
protected static final Boolean EXECUTE_FOR_GROUP
```
    Since:
    
    4.0
- Constructor Detail
  - FS_POSIX
```
protected FS_POSIX()
```
    Default constructor
  - FS_POSIX
```
protected FS_POSIX(FS src)
```
    Constructor
    
    Parameters:
    src - FS to copy some settings from
- Method Detail
  - newInstance
```
public FS newInstance()
```
    Specified by:
    
    newInstance in class FS
    
    Returns:
    a new instance of the same type of FS.
  - isGranted
```
protected static Boolean isGranted(PosixFilePermission p,
                String umask)
```
    Derives requested permission from given octal umask value as defined e.g. in http://linux.die.net/man/2/ umask.
    The umask expected here must consist of 3 or 4 digits. Last three digits are significant here because they represent file permissions granted to the "owner", "group" and "others" (in this order).
    Each single digit from the umask represents 3 bits of the mask standing for "read, write, execute" permissions (in this order).
    The possible umask values table:
```
 Value : Bits:Abbr.: Permission
     0 : 000 :rwx  : read, write and execute
     1 : 001 :rw   : read and write
     2 : 010 :rx   : read and execute
     3 : 011 :r    : read only
     4 : 100 :wx   : write and execute
     5 : 101 :w    : write only
     6 : 110 :x    : execute only
     7 : 111 :     : no permissions
 
```
    Note, that umask value is used to "mask" the requested permissions on file creation by combining the requested permission bit with the negated value of the umask bit.
    Simply speaking, if a bit is not set in the umask, then the appropriate right will be granted if requested. If a bit is set in the umask value, then the appropriate permission will be not granted.
    Example:
  - umask 023 ("000 010 011" or rwx rx r) combined with the request to create an executable file with full set of permissions for everyone (777) results in the file with permissions 754 (rwx rx r).
  - umask 002 ("000 000 010" or rwx rwx rx) combined with the request to create an executable file with full set of permissions for everyone (777) results in the file with permissions 775 (rwx rwx rx).
  - umask 002 ("000 000 010" or rwx rwx rx) combined with the request to create a file without executable rights for everyone (666) results in the file with permissions 664 (rw rw r).

Parameters:: p - non null permission; umask - octal umask value represented by at least three digits. The digits (read from the end to beginning of the umask) represent permissions for "others", "group" and "owner".
Returns:: true if the requested permission is set according to given umask
Since:: 4.0

readUmask
```
protected static String readUmask()
```
Returns:
umask returned from running umask command in a shell
Since:

4.0

discoverGitPrefix
```
protected File discoverGitPrefix()
```
Specified by:

discoverGitPrefix in class FS

Returns:
the $prefix directory C Git would use.

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

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 canExecute)
```
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.
canExecute - true to enable execution; false to disable it.

Returns:
true if the change succeeded; false otherwise.

runInShell
```
public ProcessBuilder runInShell(String cmd,
                        String[] args)
```
Description copied from class: FS

Initialize a ProcesssBuilder 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.

runHookIfPresent
```
public ProcessResult runHookIfPresent(Repository repository,
                             String hookName,
                             String[] args,
                             PrintStream outRedirect,
                             PrintStream errRedirect,
                             String stdinArgs)
                               throws JGitInternalException
```
Description copied from class: FS

Checks whether the given hook is defined for the given repository, then runs it with the given arguments.

Overrides:

runHookIfPresent in class FS

Parameters:
repository - The repository for which a hook should be run.
hookName - The name of the hook to be executed.
args - Arguments to pass to this hook. Cannot be null, but can be an empty array.
outRedirect - A print stream on which to redirect the hook's stdout. Can be null, in which case the hook's standard output will be lost.
errRedirect - A print stream on which to redirect the hook's stderr. Can be null, in which case the hook's standard error will be lost.
stdinArgs - A string to pass on to the standard input of the hook. May be null.

Returns:
The ProcessResult describing this hook's execution.

Throws:

JGitInternalException - if we fail to run the hook somehow. Causes may include an interrupted process or I/O errors.
Since:

4.0

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.

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

normalize
```
public File normalize(File file)
```
Description copied from class: FS

Normalize the unicode path to composed form.

Overrides:

normalize in class FS

Returns:
NFC-format File
Since:

3.3

normalize
```
public String normalize(String name)
```
Description copied from class: FS

Normalize the unicode path to composed form.

Overrides:

normalize in class FS

Returns:
NFC-format string
Since:

3.3

findHook
```
public File findHook(Repository repository,
            String hookName)
```
Description copied from class: FS

Tries to find a hook matching the given one in the given repository.

Overrides:

findHook in class FS

Parameters:
repository - The repository within which to find a hook.
hookName - The name of the hook we're trying to find.

Returns:
The File containing this particular hook if it exists in the given repository, null otherwise.
Since:

3.7

Class FS_POSIX

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

EXECUTE_FOR_OTHERS

EXECUTE_FOR_GROUP

Constructor Detail

FS_POSIX

FS_POSIX

Method Detail

newInstance

isGranted

readUmask

discoverGitPrefix

isCaseSensitive

supportsExecute

canExecute

setExecute

runInShell

runHookIfPresent

retryFailedLockFileCommit

supportsSymlinks

isSymLink

lastModified

setLastModified

delete

length

exists

isDirectory

isFile

isHidden

setHidden

readSymLink

createSymLink

getAttributes

normalize

normalize

findHook