FileUtil (unix4j-base 0.4 API)

java.lang.Object
- org.unix4j.util.FileUtil

```
public class FileUtil
extends Object
```
Utility class with static methods involving files.

Field Summary

Fields
Modifier and Type Field and Description

static String ROOT

static String ROOT_UNIX

static String ROOT_WINDOWS

static String ROOT_WINDOWS_NETWORK

Fields
Modifier and Type	Field and Description
`static String`	`ROOT`
`static String`	`ROOT_UNIX`
`static String`	`ROOT_WINDOWS`
`static String`	`ROOT_WINDOWS_NETWORK`

Method Summary

Methods
Modifier and Type	Method and Description
`static List<File>`	`expandFiles(File currentDirectory, String... paths)` Expands files if necessary, meaning that input files with wildcards are expanded.
`static List<File>`	`expandFiles(String... paths)` Expands files if necessary, meaning that input files with wildcards are expanded.
`static File`	`getDirectoryOfClassFile(Class<?> clazz)` This method returns the parent directory of a given class.
`static File`	`getDirectoryOfClassFile(String className)` This method returns the parent directory of a given class.
`static FilenameFilter`	`getFileNameFilter(String name)` Returns a file name filter for the specified name.
`static File`	`getOutputDirectoryGivenClass(Class<?> clazz)` This method returns the output directory of a given class.
`static List<String>`	`getPathElements(File file)` Returns all path elements of the given `file`.
`static String`	`getRelativePath(File root, File file)` Returns the path of the given `file` relative to the given `root`.
`static File`	`getUserDir()` Returns the user's current working directory taken from the system property "user.dir".
`static boolean`	`isWildcardFileName(String name)` Returns true if the given name or path contains unescaped wildcard characters.
`static File`	`toAbsoluteFile(File currentDirectory, File file)` Returns an absolute file for the given input file, resolving relative paths on the basis of the given `currentDirectory`.
`static List<File>`	`toList(File... files)` Returns the specified files in a new mutable array list.

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

- Field Detail
  - ROOT_UNIX
```
public static final String ROOT_UNIX
```
    See Also:
    Constant Field Values
  - ROOT_WINDOWS
```
public static final String ROOT_WINDOWS
```
    See Also:
    Constant Field Values
  - ROOT_WINDOWS_NETWORK
```
public static final String ROOT_WINDOWS_NETWORK
```
    See Also:
    Constant Field Values
  - ROOT
```
public static final String ROOT
```
- Method Detail
  - getUserDir
```
public static File getUserDir()
```
    Returns the user's current working directory taken from the system property "user.dir".
    
    Returns:
    the user's current working directory
    See Also:
    System.getProperties()
  - toList
```
public static List<File> toList(File... files)
```
    Returns the specified files in a new mutable array list. This is similar to Arrays.asList(Object...) but the returned list is expandable.
    
    Parameters:
    files - the files to add to a new list
    
    Returns:
    a new array list containing the specified files
  - getRelativePath
```
public static String getRelativePath(File root,
                     File file)
```
    Returns the path of the given file relative to the given root.
    The relative path is evaluated as follows:
    1. If root is the same as file, "." is returned
    2. If root is the direct parent directory of file, the simple file name is returned
    3. If root is a non-direct parent directory of file, the relative path from root to file is returned
    4. If root is not parent directory of file, the relative path is the path from root to the common ancestor and then to file
    5. If root is not parent directory of file and the only common ancestor of the two is the root directory, the absolute path of file is returned
    Examples (same order as above):
    1. ("/home/john", "/home/john") → "."
    2. ("/home/john", "/home/john/notes.txt") → "notes.txt"
    3. ("/home/john", "/home/john/documents/important") → "./documents/important"
    4. ("/home/john", "/home/smith/public/holidays.pdf") → "../smith/public/holidays.pdf"
    5. ("/home/john", "/var/tmp/test.out") → "/var/tmp/test.out"
    Parameters:
    root - the root directory for the relative path
    file - the file whose path should be returned
    
    Returns:
    the path of file relative to root
  - toAbsoluteFile
```
public static File toAbsoluteFile(File currentDirectory,
                  File file)
```
    Returns an absolute file for the given input file, resolving relative paths on the basis of the given currentDirectory. If the given file represents an absolute path or a variable, it is returned unchanged. If currentDirectory==null, File.getAbsoluteFile() is returned.
    
    Parameters:
    currentDirectory - the current directory
    file - the file to be returned as absolute file
    
    Returns:
    the absolute path version of the given file with currentDirectory as basis for relative paths
    See Also:
    File.isAbsolute(), Arg.isVariable(String), File.getAbsoluteFile()
  - getPathElements
```
public static List<String> getPathElements(File file)
```
    Returns all path elements of the given file. The absolute path of the file is used to evaluate the path elements.
    For instance, a list with the 3 elements "var", "tmp", "out.txt" is returned for an input file "/var/tmp/out.txt".
    
    Parameters:
    file - the file whose path elements should be returned
    
    Returns:
    the path elements of file
  - expandFiles
```
public static List<File> expandFiles(String... paths)
```
    Expands files if necessary, meaning that input files with wildcards are expanded. If the specified files list contains no wildcard, the files are simply returned; all wildcard files are expanded.
    
    Parameters:
    paths - the file paths, possibly containing wildcard parts
    
    Returns:
    the expanded files resolving wildcards
  - expandFiles
```
public static List<File> expandFiles(File currentDirectory,
                     String... paths)
```
    Expands files if necessary, meaning that input files with wildcards are expanded. If the specified files list contains no wildcard, the files are simply returned; all wildcard files are expanded. The given current directory serves as basis for all relative paths.
    
    Parameters:
    currentDirectory - the basis for all relative paths
    paths - the file paths, possibly containing wildcard parts
    
    Returns:
    the expanded files resolving wildcards
  - getFileNameFilter
```
public static FilenameFilter getFileNameFilter(String name)
```
    Returns a file name filter for the specified name. The name should be either a simple file name (not a path) or a wildcard expression such as "*" or "*.java".
    The wildcards "*" and "?" are supported. "*" stands for any character repeated 0 to many times, "?" for exactly one arbitrary character. Both characters can be escaped with a preceding backslash character \ (Unix and MAC) or % character (Windows).
    
    Parameters:
    name - the name or pattern without path
    
    Returns:
    a file name filter matching either the name or the pattern
  - isWildcardFileName
```
public static boolean isWildcardFileName(String name)
```
    Returns true if the given name or path contains unescaped wildcard characters. The characters "*" and "?" are considered wildcard chars if they are not escaped with a preceding backslash character \ (Unix and MAC) or % character (Windows).
    
    Parameters:
    name - the name or path
    
    Returns:
    true if the name contains unescaped wildcard characters
  - getOutputDirectoryGivenClass
```
public static File getOutputDirectoryGivenClass(Class<?> clazz)
```
    This method returns the output directory of a given class. Example: Given a class: com.abc.def.MyClass Which is outputted to a directory: /home/ben/myproject/target/com/abc/dev/MyClass.class This method will return: /home/ben/myproject/target
    
    Parameters:
    clazz -
    
    Returns:
    A file representing the output directory containing the class and parent packages
  - getDirectoryOfClassFile
```
public static File getDirectoryOfClassFile(Class<?> clazz)
```
    This method returns the parent directory of a given class. Example: Given a class: com.abc.def.MyClass Which is outputted to a directory: /home/ben/myproject/target/com/abc/def/MyClass.class This method will return: /home/ben/myproject/target/com/abc/def
    
    Parameters:
    clazz -
    
    Returns:
    A file representing the output directory containing the class and parent packages
  - getDirectoryOfClassFile
```
public static File getDirectoryOfClassFile(String className)
```
    This method returns the parent directory of a given class. Example: Given a class: com.abc.def.MyClass Which is outputted to a directory: /home/ben/myproject/target/com/abc/def/MyClass.class This method will return: /home/ben/myproject/target/com/abc/def
    
    Parameters:
    className - fully qualified class name
    
    Returns:
    A file representing the output directory containing the class and parent packages

Class FileUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ROOT_UNIX

ROOT_WINDOWS

ROOT_WINDOWS_NETWORK

ROOT

Method Detail

getUserDir

toList

getRelativePath

toAbsoluteFile

getPathElements

expandFiles

expandFiles

getFileNameFilter

isWildcardFileName

getOutputDirectoryGivenClass

getDirectoryOfClassFile

getDirectoryOfClassFile