IOUtils (illinois-cogcomp-nlp 3.1.29 API)

java.lang.Object
- edu.illinois.cs.cogcomp.core.io.IOUtils

```
public abstract class IOUtils
extends Object
```
Some utility functions involving files and directory. Some of these commands are modeled after Unix commands.

Author:

Vivek Srikumar

Constructor Summary

Constructors
Constructor and Description

IOUtils()

Constructors
Constructor and Description
`IOUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`cleanDir(String directory)` Empty a directory without deleting it
`static void`	`cp(String sourceFileName, String destFileName)` Copy a file.
`static boolean`	`exists(String file)` Check if a file exists.
`static String`	`getFileExtension(String name)` Get the extension of a file.
`static String`	`getFileName(String path)` Returns the file name from a full path.
`static String`	`getFileStem(String path)`
`static List<URL>`	`getListOfFilesInDir(String path)`
`static boolean`	`isDirectory(String dir)` Check if the argument is a directory.
`static boolean`	`isFile(String file)` Check if this the argument is a file.
`static String[]`	`ls(String directory)` List the contents of a directory.
`static String[]`	`lsDirectories(String directory)` List the directories contained within a directory.
`static String[]`	`lsFiles(String directory)` List the files contained in a directory.
`static String[]`	`lsFiles(String directory, FilenameFilter filter)` Filters the files contained in a directory.
`static String[]`	`lsFilesRecursive(String directory, FilenameFilter filter)` Filters the files contained in a directory or in its subdirectory structure.
`static List<URL>`	`lsResources(Class clazz, String path)` Lists resources that are contained within a path.
`static List<URL>`	`lsResourcesDir(Class clazz, String path)` Lists resources that are contained within a path.
`static boolean`	`mkdir(String dir)` Create a directory, if it does not exist.
`static String`	`mkTmpDir(String prefix)` Creates a temporary directory and returns its name.
`static String`	`pwd()` Get the current working directory.
`static <T> T`	`readObject(String fileName)`
`static <T> T`	`readObjectAsResource(Class clazz, String fileName)`
`static boolean`	`rm(String file)` Delete a file
`static boolean`	`rmDir(String directory)`
`static String`	`stripFileExtension(String name)` Remove the extension from the file name.
`static boolean`	`touch(String file)` Create a new empty file.
`static <T> void`	`writeObject(T object, String fileName)`

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

- Constructor Detail
  - IOUtils
```
public IOUtils()
```
- Method Detail
  - exists
```
public static boolean exists(String file)
```
    Check if a file exists.
  - isFile
```
public static boolean isFile(String file)
```
    Check if this the argument is a file.
  - isDirectory
```
public static boolean isDirectory(String dir)
```
    Check if the argument is a directory.
  - mkdir
```
public static boolean mkdir(String dir)
```
    Create a directory, if it does not exist.
  - getFileExtension
```
public static String getFileExtension(String name)
```
    Get the extension of a file. This function does not check if the file exists.
  - stripFileExtension
```
public static String stripFileExtension(String name)
```
    Remove the extension from the file name. This function does not check if the file exists.
  - getFileName
```
public static String getFileName(String path)
```
    Returns the file name from a full path.
  - getFileStem
```
public static String getFileStem(String path)
```
  - ls
```
public static String[] ls(String directory)
                   throws IOException
```
    List the contents of a directory. NOTE: Order of list is not guaranteed to be consistent across runs/machines.
    
    Throws:
    
    IOException
  - lsFiles
```
public static String[] lsFiles(String directory)
                        throws IOException
```
    List the files contained in a directory.
    
    Throws:
    
    IOException
  - lsFiles
```
public static String[] lsFiles(String directory,
                               FilenameFilter filter)
                        throws IOException
```
    Filters the files contained in a directory.
    
    Throws:
    
    IOException
  - lsFilesRecursive
```
public static String[] lsFilesRecursive(String directory,
                                        FilenameFilter filter)
                                 throws IOException
```
    Filters the files contained in a directory or in its subdirectory structure. Returns all files (not directories) that pass the filter.
    
    Throws:
    
    IOException
  - lsDirectories
```
public static String[] lsDirectories(String directory)
                              throws Exception
```
    List the directories contained within a directory.
    
    Throws:
    
    Exception
  - pwd
```
public static String pwd()
                  throws IOException
```
    Get the current working directory.
    
    Throws:
    
    IOException
  - mkTmpDir
```
public static String mkTmpDir(String prefix)
                       throws IOException
```
    Creates a temporary directory and returns its name. If this already exists, then it is deleted.
    
    Parameters:
    
    prefix - The prefix of the temporary directory name. This can be used to specify the directory where the temporary directory resides.
    
    Throws:
    
    IOException
  - touch
```
public static boolean touch(String file)
                     throws IOException
```
    Create a new empty file.
    
    Throws:
    
    IOException
  - rm
```
public static boolean rm(String file)
                  throws IOException
```
    Delete a file
    
    Returns:
    
    true only if the delete was successful
    
    Throws:
    
    IOException
  - cleanDir
```
public static boolean cleanDir(String directory)
                        throws IOException
```
    Empty a directory without deleting it
    
    Parameters:
    
    directory - The directory to be cleaned
    
    Returns:
    
    true only if cleaning was successful
    
    Throws:
    
    IOException
  - rmDir
```
public static boolean rmDir(String directory)
                     throws IOException
```
    Throws:
    
    IOException
  - cp
```
public static void cp(String sourceFileName,
                      String destFileName)
               throws IOException
```
    Copy a file. This uses Java's NIO to defer the actual heavy lifting to the OS.
    
    Throws:
    
    IOException
  - lsResources
```
public static List<URL> lsResources(Class clazz,
                                    String path)
                             throws URISyntaxException,
                                    IOException
```
    Lists resources that are contained within a path. This works for any resource on the classpath, either in the file system or in a jar file. The function returns a list of URLs, connections to which can be opened for reading.
    NB: This method works only for full file names. If you need to list the files of a directory contained in the classpath use lsResourcesDir(Class, String)
    
    Parameters:
    
    clazz - The class whose path is scanned
    
    path - The name of the resource(s) to be returned
    
    Returns:
    
    A list of URLs
    
    Throws:
    
    URISyntaxException
    
    IOException
  - lsResourcesDir
```
public static List<URL> lsResourcesDir(Class clazz,
                                       String path)
                                throws IOException
```
    Lists resources that are contained within a path. This works for any resource on the classpath, either in the file system or in a jar file. The function returns a list of URLs, connections to which can be opened for reading.
    NB: This method can be used to list the files of a directory contained in the classpath. However, since it explicitly lists the contents of each classpath resource it is very slow. If you need a list of specific files (or for directories that are not inside jars), use lsResources(Class, String)
    
    Parameters:
    
    clazz - The class whose path is scanned
    
    path - The name of the resource(s) to be returned
    
    Returns:
    
    A list of URLs
    
    Throws:
    
    IOException
  - getListOfFilesInDir
```
public static List<URL> getListOfFilesInDir(String path)
```
  - writeObject
```
public static <T> void writeObject(T object,
                                   String fileName)
                            throws IOException
```
    Throws:
    
    IOException
  - readObject
```
public static <T> T readObject(String fileName)
                        throws Exception
```
    Throws:
    
    Exception
  - readObjectAsResource
```
public static <T> T readObjectAsResource(Class clazz,
                                         String fileName)
                                  throws Exception
```
    Throws:
    
    Exception

Class IOUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IOUtils

Method Detail

exists

isFile

isDirectory

mkdir

getFileExtension

stripFileExtension

getFileName

getFileStem

ls

lsFiles

lsFiles

lsFilesRecursive

lsDirectories

pwd

mkTmpDir

touch

rm

cleanDir

rmDir

cp

lsResources

lsResourcesDir

getListOfFilesInDir

writeObject

readObject

readObjectAsResource