Util

Object
- Util

```
public class Util
extends Object
```

Constructor Summary

Constructors
Constructor and Description

Util()

Constructors
Constructor and Description
`Util()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static long`	`calcFolderSize(File folder)` Calculate the size of the contents of a folder.
`static long`	`calcSize(File file)` Function to return the length of the file, or entire directory, including the component files and sub-folders if passed.
`static boolean`	`containsNonASCII(String what)`
`static String`	`contentsToClassPath(File folder)` Given a folder, return a list of absolute paths to all jar or zip files inside that folder, separated by pathSeparatorChar.
`static void`	`copyDir(File sourceDir, File targetDir)` Copy a folder from one place to another.
`static void`	`copyDirNative(File sourceDir, File targetDir)`
`static void`	`copyFile(File sourceFile, File targetFile)`
`static int`	`countLines(String what)` Get the number of lines in a file by counting the number of newline characters inside a String (and adding 1).
`static File`	`createTempFolder(String prefix, String suffix, File directory)` Create a temporary folder by using the createTempFile() mechanism, deleting the file it creates, and making a folder using the location that was provided.
`static byte[]`	`gzipEncode(byte[] what)`
`static String[]`	`listFiles(File folder, boolean relative)` Recursively creates a list of all files within the specified folder, and returns a list of their relative paths.
`static String[]`	`listFiles(File folder, boolean relative, String extension)`
`static File[]`	`listJarFiles(File folder)`
`static byte[]`	`loadBytesRaw(File file)` Same as PApplet.loadBytes(), however never does gzip decoding.
`static String`	`loadFile(File file)` Grab the contents of a file as a string.
`static StringList`	`packageListFromClassPath(String path)` A classpath, separated by the path separator, will contain a series of .jar/.zip files or directories containing .class files, or containing subdirectories that have .class files.
`static StringDict`	`readSettings(File inputFile)` Read from a file with a bunch of attribute/value pairs that are separated by = and ignore comments with #.
`static StringDict`	`readSettings(String filename, String[] lines)` Parse a String array that contains attribute/value pairs separated by = (the equals sign).
`static boolean`	`removeDir(File dir)` Remove all files in a directory and the directory itself.
`static boolean`	`removeDir(File dir, boolean printErrorMessages)` Remove all files in a directory and the directory itself.
`static void`	`saveFile(String text, File file)` Spew the contents of a String object out to a file.
`static void`	`unzip(File zipFile, File dest)`

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

- Constructor Detail
  - Util
```
public Util()
```
- Method Detail
  - countLines
```
public static int countLines(String what)
```
    Get the number of lines in a file by counting the number of newline characters inside a String (and adding 1).
  - loadBytesRaw
```
public static byte[] loadBytesRaw(File file)
                           throws IOException
```
    Same as PApplet.loadBytes(), however never does gzip decoding.
    
    Throws:
    
    IOException
  - readSettings
```
public static StringDict readSettings(File inputFile)
```
    Read from a file with a bunch of attribute/value pairs that are separated by = and ignore comments with #. Changed in 3.x to return null (rather than empty hash) if no file, and changed return type to StringDict instead of Map or HashMap.
  - readSettings
```
public static StringDict readSettings(String filename,
                                      String[] lines)
```
    Parse a String array that contains attribute/value pairs separated by = (the equals sign). The # (hash) symbol is used to denote comments. Comments can be anywhere on a line. Blank lines are ignored. In 3.0a6, no longer taking a blank HashMap as param; no cases in the main PDE code of adding to a (Hash)Map. Also returning the Map instead of void. Both changes modify the method signature, but this was only used by the contrib classes.
  - copyFile
```
public static void copyFile(File sourceFile,
                            File targetFile)
                     throws IOException
```
    Throws:
    
    IOException
  - loadFile
```
public static String loadFile(File file)
                       throws IOException
```
    Grab the contents of a file as a string. Connects lines with \n, even if the input file used \r\n.
    
    Throws:
    
    IOException
  - saveFile
```
public static void saveFile(String text,
                            File file)
                     throws IOException
```
    Spew the contents of a String object out to a file. As of 3.0 beta 2, this will replace and write \r\n for newlines on Windows. https://github.com/processing/processing/issues/3455 As of 3.3.7, this puts a newline at the end of the file, per good practice/POSIX: https://stackoverflow.com/a/729795
    
    Throws:
    
    IOException
  - createTempFolder
```
public static File createTempFolder(String prefix,
                                    String suffix,
                                    File directory)
                             throws IOException
```
    Create a temporary folder by using the createTempFile() mechanism, deleting the file it creates, and making a folder using the location that was provided. Unlike createTempFile(), there is no minimum size for prefix. If prefix is less than 3 characters, the remaining characters will be filled with underscores
    
    Throws:
    
    IOException
  - copyDir
```
public static void copyDir(File sourceDir,
                           File targetDir)
                    throws IOException
```
    Copy a folder from one place to another. This ignores all dot files and folders found in the source directory, to avoid copying silly .DS_Store files and potentially troublesome .svn folders.
    
    Throws:
    
    IOException
  - copyDirNative
```
public static void copyDirNative(File sourceDir,
                                 File targetDir)
                          throws IOException
```
    Throws:
    
    IOException
  - removeDir
```
public static boolean removeDir(File dir)
```
    Remove all files in a directory and the directory itself. Prints error messages with failed filenames. Does not follow symlinks.
  - removeDir
```
public static boolean removeDir(File dir,
                                boolean printErrorMessages)
```
    Remove all files in a directory and the directory itself. Optinally prints error messages with failed filenames. Does not follow symlinks.
  - calcSize
```
public static long calcSize(File file)
```
    Function to return the length of the file, or entire directory, including the component files and sub-folders if passed.
    
    Parameters:
    
    file - The file or folder to calculate
  - calcFolderSize
```
public static long calcFolderSize(File folder)
```
    Calculate the size of the contents of a folder. Used to determine whether sketches are empty or not. Note that the function calls itself recursively.
  - listFiles
```
public static String[] listFiles(File folder,
                                 boolean relative)
```
    Recursively creates a list of all files within the specified folder, and returns a list of their relative paths. Ignores any files/folders prefixed with a dot.
    
    Parameters:
    
    relative - true return relative paths instead of absolute paths
  - listFiles
```
public static String[] listFiles(File folder,
                                 boolean relative,
                                 String extension)
```
  - listJarFiles
```
public static File[] listJarFiles(File folder)
```
    Parameters:
    
    folder - source folder to search
    
    Returns:
    
    a list of .jar and .zip files in that folder
  - contentsToClassPath
```
public static String contentsToClassPath(File folder)
```
    Given a folder, return a list of absolute paths to all jar or zip files inside that folder, separated by pathSeparatorChar. This will prepend a colon (or whatever the path separator is) so that it can be directly appended to another path string. As of 0136, this will no longer add the root folder as well. This function doesn't bother checking to see if there are any .class files in the folder or within a subfolder.
  - packageListFromClassPath
```
public static StringList packageListFromClassPath(String path)
```
    A classpath, separated by the path separator, will contain a series of .jar/.zip files or directories containing .class files, or containing subdirectories that have .class files.
    
    Parameters:
    
    path - the input classpath
    
    Returns:
    
    array of possible package names
  - unzip
```
public static void unzip(File zipFile,
                         File dest)
```
  - gzipEncode
```
public static byte[] gzipEncode(byte[] what)
                         throws IOException
```
    Throws:
    
    IOException
  - containsNonASCII
```
public static final boolean containsNonASCII(String what)
```

Class Util

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

Util

Method Detail

countLines

loadBytesRaw

readSettings

readSettings

copyFile

loadFile

saveFile

createTempFolder

copyDir

copyDirNative

removeDir

removeDir

calcSize

calcFolderSize

listFiles

listFiles

listJarFiles

contentsToClassPath

packageListFromClassPath

unzip

gzipEncode

containsNonASCII