public class SymbolicLinkUtils
extends java.lang.Object
Modifier | Constructor and Description |
---|---|
protected |
SymbolicLinkUtils()
Empty constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
deleteSymbolicLink(java.io.File link,
Task task)
Delete a symlink (without deleting the associated resource).
|
static SymbolicLinkUtils |
getSymbolicLinkUtils()
Method to retrieve The SymbolicLinkUtils, which is shared by
all users of this method.
|
boolean |
isDanglingSymbolicLink(java.io.File file)
Checks whether a given file is a broken symbolic link.
|
boolean |
isDanglingSymbolicLink(java.io.File parent,
java.lang.String name)
Checks whether a given file is a broken symbolic link.
|
boolean |
isDanglingSymbolicLink(java.lang.String name)
Checks whether a given file is a broken symbolic link.
|
boolean |
isSymbolicLink(java.io.File file)
Checks whether a given file is a symbolic link.
|
boolean |
isSymbolicLink(java.io.File parent,
java.lang.String name)
Checks whether a given file is a symbolic link.
|
boolean |
isSymbolicLink(java.lang.String name)
Checks whether a given file is a symbolic link.
|
public static SymbolicLinkUtils getSymbolicLinkUtils()
public boolean isSymbolicLink(java.io.File file) throws java.io.IOException
It doesn't really test for symbolic links but whether the canonical and absolute paths of the file are identical--this may lead to false positives on some platforms.
file
- the file to test. Must not be null.java.io.IOException
- on error.public boolean isSymbolicLink(java.lang.String name) throws java.io.IOException
It doesn't really test for symbolic links but whether the canonical and absolute paths of the file are identical--this may lead to false positives on some platforms.
name
- the name of the file to test.java.io.IOException
- on error.public boolean isSymbolicLink(java.io.File parent, java.lang.String name) throws java.io.IOException
It doesn't really test for symbolic links but whether the canonical and absolute paths of the file are identical--this may lead to false positives on some platforms.
parent
- the parent directory of the file to testname
- the name of the file to test.java.io.IOException
- on error.public boolean isDanglingSymbolicLink(java.lang.String name) throws java.io.IOException
It doesn't really test for symbolic links but whether Java reports that the File doesn't exist but its parent's child list contains it--this may lead to false positives on some platforms.
Note that #isSymbolicLink returns false if this method returns true since Java won't produce a canonical name different from the abolute one if the link is broken.
name
- the name of the file to test.java.io.IOException
- on error.public boolean isDanglingSymbolicLink(java.io.File file) throws java.io.IOException
It doesn't really test for symbolic links but whether Java reports that the File doesn't exist but its parent's child list contains it--this may lead to false positives on some platforms.
Note that #isSymbolicLink returns false if this method returns true since Java won't produce a canonical name different from the abolute one if the link is broken.
file
- the file to test.java.io.IOException
- on error.public boolean isDanglingSymbolicLink(java.io.File parent, java.lang.String name) throws java.io.IOException
It doesn't really test for symbolic links but whether Java reports that the File doesn't exist but its parent's child list contains it--this may lead to false positives on some platforms.
Note that #isSymbolicLink returns false if this method returns true since Java won't produce a canonical name different from the abolute one if the link is broken.
parent
- the parent directory of the file to testname
- the name of the file to test.java.io.IOException
- on error.public void deleteSymbolicLink(java.io.File link, Task task) throws java.io.IOException
This is a utility method that removes a unix symlink without removing the resource that the symlink points to. If it is accidentally invoked on a real file, the real file will not be harmed, but silently ignored.
Normaly this method works by getting the canonical path of the link, using the canonical path to rename the resource (breaking the link) and then deleting the link. The resource is then returned to its original name inside a finally block to ensure that the resource is unharmed even in the event of an exception.
There may be cases where the algorithm described above doesn't work, in that case the method tries to use the native "rm" command on the symlink instead.
link
- A File
object of the symlink to delete.task
- An Ant Task required if "rm" needs to be invoked.java.io.IOException
- If calls to File.rename
,
File.delete
or File.getCanonicalPath
fail.BuildException
- if the execution of "rm" failed.