FileOps (Concourse Java API)

Object
- FileOps

```
public class FileOps
extends Object
```
Generic file utility methods that compliment and expand upon those found in Files and Files.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static Set<Watchable>`	`REGISTERED_WATCHER_PATHS` A collection of `Watchable` paths that have already been registered with the `#FILE_CHANGE_WATCHER`.

Constructor Summary

Constructors
Modifier Constructor and Description

protected FileOps()

Constructors
Modifier	Constructor and Description
`protected`	`FileOps()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`append(String content, String file)` Write the String `content` to the end of the `file`, preserving anything that was previously there.
`static void`	`awaitChange(String file)` Cause the current thread to block while waiting for a change to `file`.
`static void`	`awaitChangeInterruptibly(String file)` Cause the current thread to block while waiting for a change to `file`.
`static String`	`expandPath(String path)` Expand the given `path` so that it contains completely normalized components (e.g.
`static String`	`expandPath(String path, String cwd)` Expand the given `path` so that it contains completely normalized components (e.g.
`static String`	`getUserHome()` Return the home directory of the user of the parent process for this JVM.
`static String`	`getWorkingDirectory()` Get the working directory of this JVM, which is the directory from which the process is launched.
`static boolean`	`isDirectory(String path)` Return `true` if the specified `path` is that of a directory and not a flat file.
`static void`	`mkdirs(String path)` Create the directories named by `path`, including any necessary, but nonexistent parent directories.
`static DirectoryStream<Path>`	`newDirectoryStream(Path dir)` Return a `DirectoryStream` in the same manner as `Files.newDirectoryStream(Path)` without throwing a checked exception.
`static String`	`read(String file)` Read the contents of `file` into a UTF-8 string.
`static List<String>`	`readLines(String file)` Return a list that lazily accumulates lines in the underlying `file`.
`static List<String>`	`readLines(String file, String cwd)` Return a list that lazily accumulates lines in the underlying `file`.
`static String`	`tempDir(String prefix)` Create a temporary directory with the specified `prefix`.
`static String`	`tempFile()` Create a temporary file that is likely to be deleted some time after this JVM terminates, but definitely not before.
`static String`	`tempFile(String prefix)` Create a temporary file that is likely to be deleted some time after this JVM terminates, but definitely not before.
`static String`	`tempFile(String prefix, String suffix)` Create a temporary file that is likely to be deleted some time after this JVM terminates, but definitely not before.
`static String`	`tempFile(String dir, String prefix, String suffix)` Create a temporary file that is likely to be deleted some time after this JVM terminates, but definitely not before.
`static String`	`touch(String file)` Create an empty file or update the last updated timestamp on the same as the unix command of the same name.
`static URL`	`toURL(String path)` A shortcut for getting a `URL` instance from a file path.
`static void`	`write(String content, String file)` Write the String `content` to the `file`, overwriting anything that was previously there.

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

- Field Detail
  - REGISTERED_WATCHER_PATHS
```
protected static Set<Watchable> REGISTERED_WATCHER_PATHS
```
    A collection of Watchable paths that have already been registered with the #FILE_CHANGE_WATCHER.
- Constructor Detail
  - FileOps
```
protected FileOps()
```
- Method Detail
  - append
```
public static void append(String content,
                          String file)
```
    Write the String content to the end of the file, preserving anything that was previously there.
    
    Parameters:
    
    content - the data to write
    
    file - the path to the file
  - awaitChange
```
public static void awaitChange(String file)
```
    Cause the current thread to block while waiting for a change to file.
    Because of limitations of most underlying file systems, this method can only guarantee changes that occur at least 1 second after this method is invoked. For changes that occur less than 1 second of method invocation, the method will return immediately; however, there is a chance that such a return is indicative of a false positive case where the file changed before this method was invoked, but within the same second of the invocation.
    
    If protection against that kind of false positive is important, the caller should check the contents of the underlying file is this method returns immediately.
    
    Parameters:
    
    file - the path to a regular file
  - awaitChangeInterruptibly
```
public static void awaitChangeInterruptibly(String file)
                                     throws InterruptedException
```
    Cause the current thread to block while waiting for a change to file.
    Because of limitations of most underlying file systems, this method can only guarantee changes that occur at least 1 second after this method is invoked. For changes that occur less than 1 second of method invocation, the method will return immediately; however, there is a chance that such a return is indicative of a false positive case where the file changed before this method was invoked, but within the same second of the invocation.
    
    If protection against that kind of false positive is important, the caller should check the contents of the underlying file is this method returns immediately.
    
    Parameters:
    
    file - the path to a regular file
    
    Throws:
    
    InterruptedException
  - expandPath
```
public static String expandPath(String path)
```
    Expand the given path so that it contains completely normalized components (e.g. ".", "..", and "~" are resolved to the correct absolute paths).
    
    Parameters:
    
    path -
    
    Returns:
    
    the expanded path
  - expandPath
```
public static String expandPath(String path,
                                String cwd)
```
    Expand the given path so that it contains completely normalized components (e.g. ".", "..", and "~" are resolved to the correct absolute paths).
    
    Parameters:
    
    path -
    
    cwd -
    
    Returns:
    
    the expanded path
  - getUserHome
```
public static String getUserHome()
```
    Return the home directory of the user of the parent process for this JVM.
    
    Returns:
    
    the home directory
  - getWorkingDirectory
```
public static String getWorkingDirectory()
```
    Get the working directory of this JVM, which is the directory from which the process is launched.
    
    Returns:
    
    the working directory
  - isDirectory
```
public static boolean isDirectory(String path)
```
    Return true if the specified path is that of a directory and not a flat file.
    
    Parameters:
    
    path - the path to check
    
    Returns:
    
    true if the path is that of a directory
  - mkdirs
```
public static void mkdirs(String path)
```
    Create the directories named by path, including any necessary, but nonexistent parent directories.
    NOTE: If this operation fails, it may have succeeded in creating some of the necessary parent directories.
    
    Parameters:
    
    path - the path of directories to create
  - newDirectoryStream
```
public static DirectoryStream<Path> newDirectoryStream(Path dir)
```
    Return a DirectoryStream in the same manner as Files.newDirectoryStream(Path) without throwing a checked exception.
    
    Parameters:
    
    dir - the Path for the directory
    
    Returns:
    
    a DirectoryStream
  - read
```
public static String read(String file)
```
    Read the contents of file into a UTF-8 string.
    
    Parameters:
    
    file -
    
    Returns:
    
    the file content
  - readLines
```
public static List<String> readLines(String file)
```
    Return a list that lazily accumulates lines in the underlying file.
    This method is really just syntactic sugar for reading lines from a file, so the returned list doesn't actually allow any operations other than forward iteration.
    
    Parameters:
    
    file -
    
    Returns:
    
    a "list" of lines in the file
  - readLines
```
public static List<String> readLines(String file,
                                     String cwd)
```
    Return a list that lazily accumulates lines in the underlying file.
    This method is really just syntactic sugar for reading lines from a file, so the returned list doesn't actually allow any operations other than forward iteration.
    
    Parameters:
    
    file -
    
    cwd -
    
    Returns:
    
    a "list" of lines in the file
  - tempDir
```
public static String tempDir(String prefix)
```
    Create a temporary directory with the specified prefix.
    
    Parameters:
    
    prefix - the directory name prefix
    
    Returns:
    
    the path to the temporary directory
  - tempFile
```
public static String tempFile()
```
    Create a temporary file that is likely to be deleted some time after this JVM terminates, but definitely not before.
    
    Returns:
    
    the absolute path where the temp file is stored
  - tempFile
```
public static String tempFile(String prefix)
```
    Create a temporary file that is likely to be deleted some time after this JVM terminates, but definitely not before.
    
    Parameters:
    
    prefix - the prefix for the temp file
    
    Returns:
    
    the absolute path where the temp file is stored
  - tempFile
```
public static String tempFile(String prefix,
                              String suffix)
```
    Create a temporary file that is likely to be deleted some time after this JVM terminates, but definitely not before.
    
    Parameters:
    
    prefix - the prefix for the temp file
    
    suffix - the suffix for the temp file
    
    Returns:
    
    the absolute path where the temp file is stored
  - tempFile
```
public static String tempFile(String dir,
                              String prefix,
                              String suffix)
```
    Create a temporary file that is likely to be deleted some time after this JVM terminates, but definitely not before.
    
    Parameters:
    
    dir - the absolute path to the directory in which the temp file should be created
    
    prefix - the prefix for the temp file
    
    suffix - the suffix for the temp file
    
    Returns:
    
    the absolute path where the temp file is stored
  - touch
```
public static String touch(String file)
```
    Create an empty file or update the last updated timestamp on the same as the unix command of the same name.
    
    Parameters:
    
    file - the path of the file to touch
    
    Returns:
    
    the value of file in case it needs to be passed to a super constructor
  - toURL
```
public static URL toURL(String path)
```
    A shortcut for getting a URL instance from a file path.
    
    Parameters:
    
    path - the path to the file or directory
    
    Returns:
    
    the URL that corresponds to path
  - write
```
public static void write(String content,
                         String file)
```
    Write the String content to the file, overwriting anything that was previously there.
    
    Parameters:
    
    content - the data to write
    
    file - the path to the file

Class FileOps

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

REGISTERED_WATCHER_PATHS

Constructor Detail

FileOps

Method Detail

append

awaitChange

awaitChangeInterruptibly

expandPath

expandPath

getUserHome

getWorkingDirectory

isDirectory

mkdirs

newDirectoryStream

read

readLines

readLines

tempDir

tempFile

tempFile

tempFile

tempFile

touch

toURL

write