IOUtils (PhysPics Tools API)

java.lang.Object
- com.physpics.tools.IOUtils

public class IOUtils
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`IOUtils.AudioAsset` An object for keeping a sound in memory.
`static class`	`IOUtils.InfoInputStream` Class to return out-of-band data with a buffered input stream.
`static class`	`IOUtils.LocatorType` Identify the scheme that generated an InfoInputStream.
`static class`	`IOUtils.StreamConsumer` Tool for consuming an inutstream in a separate thread.
`static interface`	`IOUtils.StreamToObject` Interface for parsers that read a file and produce an Object

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CYGWIN_ROOT`
`static int`	`DATA`
`static java.util.regex.Pattern`	`DATA_PAT` A Pattern for parsing a data: URI
`static java.util.HashMap<java.lang.String,java.lang.String>`	`EXTENSION_TO_MIME`
`protected static char[]`	`HEX_ARRAY`
`static int`	`MIMEPARAMS`
`static int`	`MIMETYPE`
`static int`	`QUERY`
`static int`	`RELPATH`
`static int`	`SCHEME`
`static java.util.regex.Pattern`	`SCHEME_PAT` Pattern that matches a leading "scheme:".
`static int`	`SLASHES`
`static java.util.regex.Pattern`	`URI_PAT` A Pattern for parsing a URI string
`protected static java.nio.file.Path`	`workDir` A working directory notion for this application.

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 java.lang.String`	`absolutize(java.lang.String locator)` Convert a locator to be absolute, if possible.
`static java.lang.String`	`absolutize(java.lang.String locator, File dir)` Convert a locator to be absolute, if possible.
`static java.lang.String`	`absolutize(java.lang.String locator, java.nio.file.Path dir)` Convert a locator to be absolute, if possible.
`static java.lang.String`	`basename(File f, java.lang.String suffix)` parses a File name returning it with the path and suffix removed
`static java.lang.String`	`basename(java.lang.String fnm)` parses a File name returning it with the path removed
`static java.lang.String`	`basename(java.lang.String name, java.lang.String suffix)` parses a String to remove path and suffix
`static void`	`browse(javax.swing.event.HyperlinkEvent e)` Open the user's default browser to the link in the event.
`static void`	`browse(java.lang.String dest)` Open the user's default browser to the given link.
`static void`	`browse(java.net.URL url)` Open the user's default browser to the URL.This method throws exceptions.For a generic message handler, use the verion of this method with a String argument.
`static java.lang.String`	`bytesToHex(byte[] bytes)` Convert an array of bytes to a mixed string.
`static File`	`canonicalize(java.lang.String loc, File workDir, java.lang.Class klass)` Convert a locator to be canonical.
`static File`	`capitalizeDriveLetter(File f)` Make the drive letter upper case.
`static java.nio.charset.Charset`	`checkCharset(java.lang.String name)` Checks if there is a charset for a given name.
`static java.net.URL`	`classURL(java.lang.Object obj)` Produce a jar: URL for a member's class.The jar format is jar:{.jar file's URL}!/dir/dir/classname.class where the /dir/dir elements are the names in the class's binary name.
`static File`	`dirFromEnv(java.lang.String var)`
`static java.lang.String`	`dirname(java.lang.String name)`
`static java.util.ArrayList<java.lang.String>`	`exec(java.lang.String name, long maxTime, java.lang.String cmd)` Execute a shell command and return the output.Does not return until the command is completed.
`static java.util.ArrayList<java.lang.String>`	`exec(java.lang.String name, long maxTime, java.lang.String cmd, java.util.function.Consumer<java.lang.String> err)` Execute a shell command and return the output.
`static java.util.ArrayList<java.lang.String>`	`exec(java.lang.String name, java.lang.String cmd)` Execute a shell command and return the output.
`static java.lang.String`	`extension(File f)` extracts everything in f.getName() after the last dot.
`static java.lang.String`	`extension(java.lang.String name)` extracts everything in name after the last dot.
`static java.net.URL`	`f2U(File f)` Convert file name to URL.
`static java.lang.Object`	`fetchFromLocator(java.lang.Class<?> aClass, java.lang.String src, java.lang.Object sample)` Read from an URL with parameters and produce an appropriate Object: String, JEditorPane, org.w3c.dom.Document, Image, byte[] The parameters depend on type
`static java.lang.String`	`fileToUnix(File winF)` Convert a file name to Unix format.
`static FilenameFilter`	`getAcceptAllFilter()` Produce a FilenameFilter that accepts all files
`static javax.swing.JComponent`	`getComponentFor(java.lang.Object obj)` Get a viewer for one of the objects returned by fetchAsset
`static File`	`getDIR_HOME()`
`static File`	`getDIR_JAVAROOT()`
`static File`	`getDIR_PICTOOLS()`
`static File`	`getDIR_WEBROOT()`
`static IOUtils.InfoInputStream`	`getInputStream(java.lang.Class<?> aClass, java.lang.String src)` Get a InputStream given a source specification.
`static java.net.URL`	`getJarURL(java.lang.Class<?> aClass)` Compute a URL that will access the jar holding a given class.
`static java.lang.String`	`getMimeForExt(java.lang.String ext)`
`static IOUtils.StreamToObject`	`getParserForMime(java.lang.String mime)` Given a mime type, returns an appropriate parser.
`static File`	`getPHYSPICS_INI_DIR()`
`static FilenameFilter`	`getPrefixFilter(java.lang.String nameStart)` Produce a FilenameFilter that checks that the name starts with a given prefix.
`static Reader`	`getReader(java.lang.Class<?> aClass, IOUtils.InfoInputStream iis)` Get a Reader as described by a scheme.
`static Reader`	`getReader(java.lang.Class<?> aClass, java.lang.String src)` Get a Reader as described by a scheme.
`static java.lang.String`	`getSibling(java.lang.String base, java.lang.String sibling)` Given a filename string, compute the string name for a sibling.
`static File`	`getWorkDir()`
`static File`	`getWritableFile(java.lang.String name)` Given a name, return a File that is at that name and is writeable.
`static File`	`jarDir(java.lang.Class<?> aClass)` Get a File for the directory containing the jar.
`static java.net.URL`	`jarDirURL(java.lang.Class<?> aclass)` Get an URL for the directory containing a jar -- the jar from which a given class was loaded.
`static File`	`jarFile(java.lang.Class<?> aClass)` Get a File object for a jar file.
`static java.net.URL`	`jarURLtoJarParent(java.net.URL jarURL)` Computes an URL that is parent to all siblings of the argument.
`static javax.swing.ImageIcon`	`loadIcon(java.lang.Class<?> app, java.lang.String name)` Load an image and make an ImageIcon from it.
`static javax.swing.Icon`	`loadIconResource(java.lang.Class<?> app, java.lang.String name)` Load a resource as an Icon (in fact, an ImageIcon).
`static java.awt.image.BufferedImage`	`loadImage(java.lang.Class<?> app, java.lang.String name)` Load an Image as named by an IOUtils locator.
`static java.awt.Image`	`loadImageResource(java.lang.Class<?> app, java.lang.String name)` Load a resource as an Image.
`static File`	`locatorFile(java.lang.Class<?> aClass, java.lang.String src)` Parse a locator to get the corresponding file, if any.
`static File`	`nativize(File f)` Convert a File to a File for current platform.
`static File`	`nativize(java.lang.String fnm)` Convert a filename to a File for current platform.
`static File`	`newExtension(File f, java.lang.String ext)` /** Change extension on filename.
`static java.lang.String`	`newExtension(java.lang.String path, java.lang.String ext)`
`static void`	`printRootDirectories()`
`static void`	`putMimeForExt(java.lang.String ext, java.lang.String mime)`
`static void`	`putParserForMime(java.lang.String mime, IOUtils.StreamToObject parser)`
`static java.lang.String`	`readWholeFile(BufferedReader brdr)` Read the entire contents of a BufferedReader.
`static java.lang.String`	`readWholeFile(File f)` Read a File in its entirety.
`static java.lang.String`	`readWholeFile(InputStream is)` Read an InputStream in its entirety.
`static java.lang.String`	`readWholeFile(Reader rdr)` Read the entire contents of a Reader.
`static java.lang.String`	`readWholeFile(java.lang.String name)` Read a named file in its entirety.
`static java.lang.String`	`relativize(java.lang.String locator)` Convert a locator to a file relative to workDir, if possible.
`static java.lang.String`	`relativize(java.lang.String locator, File dir)` Convert a locator to a value relative to the given dir, if possible.
`static java.lang.String`	`relativize(java.lang.String locator, java.nio.file.Path path)` Convert a locator to a value relative to the given dir, if possible.
`static File`	`saveAnyOldVersion(File f)` If an old version of the file exists, move it to xxx-old.txt
`static void`	`setWorkDir(File f)` Set a working directory for the application.
`static void`	`showObject(java.lang.String title, javax.swing.JComponent comp)`
`static java.lang.String`	`stemname(File f)` Parses a File name returning the name with the extension removed.
`static java.lang.String`	`stemname(File f, java.lang.String suffix)` parses a file's String name returning it with a suffix removed
`static java.lang.String`	`stemname(java.lang.String fnm)` Parses a file's path name returning the name with the extension removed.
`static java.lang.String`	`stemname(java.lang.String fnm, java.lang.String suffix)` parses a File name returning it with the suffix removed
`static File`	`valueForFinalDir(java.lang.String fnm)` Make a File for fnm and check its usability.
`static void`	`writeWholeString(File f, java.lang.String s)` Write a String to be the contents of a file.

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

- Field Detail
  - CYGWIN_ROOT
```
public static final java.lang.String CYGWIN_ROOT
```
  - workDir
```
protected static java.nio.file.Path workDir
```
    A working directory notion for this application. Suitable for making file names absolute. The value of user.dir is often useless. default value is null, which will cause NPE errors
  - SCHEME_PAT
```
public static final java.util.regex.Pattern SCHEME_PAT
```
    Pattern that matches a leading "scheme:".
  - URI_PAT
```
public static final java.util.regex.Pattern URI_PAT
```
    A Pattern for parsing a URI string
  - SCHEME
```
public static final int SCHEME
```
    See Also:
    
    Constant Field Values
  - SLASHES
```
public static final int SLASHES
```
    See Also:
    
    Constant Field Values
  - RELPATH
```
public static final int RELPATH
```
    See Also:
    
    Constant Field Values
  - QUERY
```
public static final int QUERY
```
    See Also:
    
    Constant Field Values
  - DATA_PAT
```
public static final java.util.regex.Pattern DATA_PAT
```
    A Pattern for parsing a data: URI
  - MIMETYPE
```
public static final int MIMETYPE
```
    See Also:
    
    Constant Field Values
  - MIMEPARAMS
```
public static final int MIMEPARAMS
```
    See Also:
    
    Constant Field Values
  - DATA
```
public static final int DATA
```
    See Also:
    
    Constant Field Values
  - EXTENSION_TO_MIME
```
public static final java.util.HashMap<java.lang.String,java.lang.String> EXTENSION_TO_MIME
```
  - HEX_ARRAY
```
protected static final char[] HEX_ARRAY
```
- Constructor Detail
  - IOUtils
```
public IOUtils()
```
- Method Detail
  - setWorkDir
```
public static void setWorkDir(File f)
```
    Set a working directory for the application.
    
    Parameters:
    
    f - The directory to set. No testing is performed. The value is converted to a Path.
  - getWorkDir
```
public static File getWorkDir()
```
    Returns:
    
    The current work directory.
  - getDIR_WEBROOT
```
public static File getDIR_WEBROOT()
```
    Returns:
    
    the DIR_WEBROOT, value of environment variable SRCROOT.
  - getDIR_JAVAROOT
```
public static File getDIR_JAVAROOT()
```
    Returns:
    
    the DIR_JAVAROOT, value of environment variable JAVAROOT. On many platforms it equals System.getProperty("java.home").
  - getDIR_PICTOOLS
```
public static File getDIR_PICTOOLS()
```
    Returns:
    
    the DIR_PICTOOLS, value of environment variable PICTOOLS.
  - getDIR_HOME
```
public static File getDIR_HOME()
```
    Returns:
    
    the DIR_HOME, value of environment variable HOME, or if that is not set, the value of System.getProperty("user.home"). The two values or usually the same, unless the user has taken steps to change the value in the environment. (Java does not check the environment to set user.home.)
  - getPHYSPICS_INI_DIR
```
public static File getPHYSPICS_INI_DIR()
```
    Returns:
    
    the user's chosen directory for java initialization files. Nominally DIR_HOME/.physpics/. May be set in the shell environment.
  - printRootDirectories
```
public static void printRootDirectories()
```
  - browse
```
public static void browse(javax.swing.event.HyperlinkEvent e)
```
    Open the user's default browser to the link in the event.
    
    Parameters:
    
    e - The Hyperlinkevent that occurred. If not of type ACTIVATED, it is ignored.
  - browse
```
public static void browse(java.lang.String dest)
```
    Open the user's default browser to the given link. This method sends to the Message window a generic description of any Exceptions. For more specific handling of Exceptions, use the browse method with the URL arugment.
    
    Parameters:
    
    dest - String version of the destgination .
  - browse
```
public static void browse(java.net.URL url)
                   throws java.net.URISyntaxException,
                          IOException
```
    Open the user's default browser to the URL.This method throws exceptions.For a generic message handler, use the verion of this method with a String argument.
    
    Parameters:
    
    url - desired page to view
    
    Throws:
    
    java.net.URISyntaxException - browse got invalid input
    
    IOException - browse got invalid input
  - capitalizeDriveLetter
```
public static File capitalizeDriveLetter(File f)
```
    Make the drive letter upper case. This is mostly useful for comparing or printing file names.
    
    Parameters:
    
    f - File whose name is to be modified.
    
    Returns:
    
    a possibly-new file whose name has n upper-case drive letter.
  - valueForFinalDir
```
public static File valueForFinalDir(java.lang.String fnm)
```
    Make a File for fnm and check its usability. Used for setting global directory values, which are final.
    
    Parameters:
    
    fnm - The file name
    
    Returns:
    
    A File for fnm if it is a readable directory; otherwise null.
  - dirFromEnv
```
public static final File dirFromEnv(java.lang.String var)
```
    Parameters:
    
    var - The name of a system property whose value is the name of the desired value.
    
    Returns:
    
    a File whose name is in the system environment property var
  - extension
```
public static java.lang.String extension(File f)
```
    extracts everything in f.getName() after the last dot.
    
    Parameters:
    
    f - The victim File whose getName() is parsed
    
    Returns:
    
    the extension on the file name.
  - extension
```
public static java.lang.String extension(java.lang.String name)
```
    extracts everything in name after the last dot.
    
    Parameters:
    
    name - A name to have its extension returned
    
    Returns:
    
    everything after last dot. Returns the empty string both when there is no extension and when the string ends in dot.
  - newExtension
```
public static java.lang.String newExtension(java.lang.String path,
                                            java.lang.String ext)
```
    Parameters:
    
    path - A String whose name has or has not an extension
    
    ext - the extension on the result String (if leading period is omitted, it will be supplied)
    
    Returns:
    
    a new path string with extension changed to a given extension.
  - newExtension
```
public static File newExtension(File f,
                                java.lang.String ext)
```
    /** Change extension on filename.
    
    Parameters:
    
    f - A file whose name has or has not an extension
    
    ext - the extension on the result File (if leading period is omitted, it will be supplied)
    
    Returns:
    
    a new File with extension changed to a given extension.
  - stemname
```
public static java.lang.String stemname(File f)
```
    Parses a File name returning the name with the extension removed.
    
    Parameters:
    
    f - The File whose name to process
    
    Returns:
    
    Everything in the file's name except a final dot and extension. If there is no extension, returns the entire name
  - stemname
```
public static java.lang.String stemname(java.lang.String fnm)
```
    Parses a file's path name returning the name with the extension removed.
    
    Parameters:
    
    fnm - The File whose name to process
    
    Returns:
    
    Everything in the file's name except a final dot and extension. If there is no extension, returns the entire name
  - stemname
```
public static java.lang.String stemname(File f,
                                        java.lang.String suffix)
```
    parses a file's String name returning it with a suffix removed
    
    Parameters:
    
    f - The file path to process
    
    suffix - a trailing String to remove. Need not be solely an extension. If a period in an extension is to be removed, it must appear in this argument. If suffix is empty, remove a trailing extension, if any.
    
    Returns:
    
    Everything in the name prior to the suffix. Or prior to the extension if the suffix is empty.
  - stemname
```
public static java.lang.String stemname(java.lang.String fnm,
                                        java.lang.String suffix)
```
    parses a File name returning it with the suffix removed
    
    Parameters:
    
    fnm - The filename to process
    
    suffix - a trailing String to remove. Need not be solely an extension. If a period in an extension is to be removed, it must appear in this argument. If suffix is empty, remove a trailing extension, if any.
    
    Returns:
    
    Everything in the name prior to the suffix. Or prior to the extension if the suffix is empty.
  - basename
```
public static java.lang.String basename(java.lang.String fnm)
```
    parses a File name returning it with the path removed
    
    Parameters:
    
    fnm - The filename to process
    
    Returns:
    
    everything in fnm after last slash and before the final dot
  - basename
```
public static java.lang.String basename(File f,
                                        java.lang.String suffix)
```
    parses a File name returning it with the path and suffix removed
    
    Parameters:
    
    f - The File whose name to process
    
    suffix - The suffix to remove, or null to remove any extension. Note that the suffix is arbitrary and may or may not include a dot. Example: "-paged.txt" will remove that entire string if found at the end
    
    Returns:
    
    f.getName() with the suffix removed. If suffix is null, returns the getName() value without its extension; that is it returns everything before the last .
  - basename
```
public static java.lang.String basename(java.lang.String name,
                                        java.lang.String suffix)
```
    parses a String to remove path and suffix
    
    Parameters:
    
    name - The string to act upon *
    
    suffix - The suffix to remove, or null to just remove the extension. Note that the suffix is arbitrary and may or may not include a dot. Example: "-paged.txt" will remove that entire string if found at the end. To remove the path and leave the extension alone, pass "" as the value for suffix.
    
    Returns:
    
    f.getName() with the suffix removed. If suffix is null, returns the getName() value without its extension; that is it returns everything before the last .
  - dirname
```
public static java.lang.String dirname(java.lang.String name)
```
    Parameters:
    
    name - A file name referring to a directory
    
    Returns:
    
    the directory portion of a file name. That is, everything from start to last slash, including that last slash. If there is no slash, the return value is "."
  - f2U
```
public static final java.net.URL f2U(File f)
```
    Convert file name to URL.
    
    Parameters:
    
    f - a File
    
    Returns:
    
    a URL that refers to the File or null for error
  - relativize
```
public static java.lang.String relativize(java.lang.String locator)
```
    Convert a locator to a file relative to workDir, if possible. The result should be more suitable for display to a user than an absolute name.
    
    Parameters:
    
    locator - The value to be revised.
    
    Returns:
    
    A version of the locator relative to dir. If locator was not absolute, it is returned. If locator was absolute and not relative to dir, locator is returned unchanged.
  - relativize
```
public static java.lang.String relativize(java.lang.String locator,
                                          File dir)
```
    Convert a locator to a value relative to the given dir, if possible. The result should be more suitable for display to user than an absolute name.
    
    Parameters:
    
    locator - The value to be revised.
    
    dir - the basis for the relativity.
    
    Returns:
    
    A version of the locator relative to dir. If locator was not absolute, it is returned. If locator was absolute and not relative to dir, locator is returned unchanged.
  - relativize
```
public static java.lang.String relativize(java.lang.String locator,
                                          java.nio.file.Path path)
```
    Convert a locator to a value relative to the given dir, if possible. The result should be more suitable for display to user than an absolute name.
    
    Parameters:
    
    locator - The value to be revised.
    
    path - the basis for the relativity.
    
    Returns:
    
    A version of the locator relative to dir. If locator was not absolute, it is returned. If locator was absolute and not relative to dir, locator is returned unchanged.
  - absolutize
```
public static java.lang.String absolutize(java.lang.String locator)
```
    Convert a locator to be absolute, if possible.
    
    Parameters:
    
    locator - A locator String.
    
    Returns:
    
    The original locator or, if possible, an absolute file referring to the same actual file. If f was absolute or scheme-based, it is returned unchanged.
  - absolutize
```
public static java.lang.String absolutize(java.lang.String locator,
                                          File dir)
```
    Convert a locator to be absolute, if possible.
    
    Parameters:
    
    locator - A locator String.
    
    dir - The basis absolute directory.
    
    Returns:
    
    The original locator or, if possible, an absolute file referring to the same actual file. If f was absolute or scheme-based, it is returned unchanged.
  - absolutize
```
public static java.lang.String absolutize(java.lang.String locator,
                                          java.nio.file.Path dir)
```
    Convert a locator to be absolute, if possible.
    
    Parameters:
    
    locator - A locator String.
    
    dir - The basis absolute directory
    
    Returns:
    
    The original locator or, if possible, an absolute file referring to the same actual file. If f was absolute or scheme-based, it is returned unchanged.
  - canonicalize
```
public static File canonicalize(java.lang.String loc,
                                File workDir,
                                java.lang.Class klass)
```
    Convert a locator to be canonical. This changes the value only if it refers to a file.
    
    Parameters:
    
    loc - the locator to be revised
    
    workDir - Directory for absolutizing a relative name
    
    klass - A class in the jar where resource: should be found
    
    Returns:
    
    a File in canonical form or else null
  - nativize
```
public static File nativize(File f)
```
    Convert a File to a File for current platform.
    
    Parameters:
    
    f - the File to be converted
    
    Returns:
    
    a File corresponding to f, but in Native operating system form.
    
    See Also:
    
    nativize(java.lang.String)
  - nativize
```
public static File nativize(java.lang.String fnm)
```
    Convert a filename to a File for current platform. For windows (File.separator is '\\') /dir/dir/f.ext => c:\\Cygwin64\\dir\\dir\\f.ext /cygdrive/d/dir/dir/e.ext => d:\\dir\\dir\\f.ext D:\\dir\\dir\\f.ext => D:\\dir\\dir\\f.ext For File.separator is '/' /dir/dir/f.ext => /dir/dir/f.ext /cygdrive/d/dir/dir/e.ext => /cygdrive/d/dir/dir/e.ext D:\\dir\\dir\\f.ext => /cygdrive/d/dir/dir/e.ext
    
    Parameters:
    
    fnm - The file name.
    
    Returns:
    
    A File object adapted to the current host.
  - fileToUnix
```
public static java.lang.String fileToUnix(File winF)
```
    Convert a file name to Unix format. Assures the slashes are forward and drive letter X: is written as /cygdrive/X/
    
    Parameters:
    
    winF - File with name to be converted (or retained) in Unix form. The name will be requested with getAbsolutePath; the client must assure that it is absolute with respect to the directory it is in.
    
    Returns:
    
    The revised file name as a String.
  - getSibling
```
public static java.lang.String getSibling(java.lang.String base,
                                          java.lang.String sibling)
```
    Given a filename string, compute the string name for a sibling. However, if the 'base' value ends in a slash, a child of that directory is returned instead. . Essentially the same as dirname(base)+sibling
    
    Parameters:
    
    base - A filename as a string.
    
    sibling - The file to be found in the base's directory. An initial slash is ignored, but internal slashes are kept.
    
    Returns:
    
    a sibling to the base. If base has no slash, the return value is the sibling string.
  - jarURLtoJarParent
```
public static java.net.URL jarURLtoJarParent(java.net.URL jarURL)
```
    Computes an URL that is parent to all siblings of the argument. If the argument is a directory, it is the parent unless it is .../classes/ (which means e are in development tree). Otherwise the final item is assumed to be a file (probably a jar file) and it is stripped back to the slash.
    
    Parameters:
    
    jarURL - The URL whose sibling directory to compute.
    
    Returns:
    
    An URL suitable for fetching siblings of jarURL. In case of exceptions, the original URL is returned.
  - jarFile
```
public static File jarFile(java.lang.Class<?> aClass)
```
    Get a File object for a jar file. The jar directory is then getJarFile(class).getAbsoluteFile().getParentFile()
    
    Parameters:
    
    aClass - The class whose jar is to be used.
    
    Returns:
    
    a File for the jar. If there is an error, return null. If the jar is not a file ending in ".jar", return null. The latter occurs during testing; at that time the jar is ./build/classes.
  - jarDir
```
public static File jarDir(java.lang.Class<?> aClass)
```
    Get a File for the directory containing the jar.
    
    Parameters:
    
    aClass - A member class of the desired jar.
    
    Returns:
    
    A URL. It may be a local directory or a web directory.
  - jarDirURL
```
public static java.net.URL jarDirURL(java.lang.Class<?> aclass)
```
    Get an URL for the directory containing a jar -- the jar from which a given class was loaded.
    
    Parameters:
    
    aclass - The class whose jar is to be used.
    
    Returns:
    
    A URL. It may be a local directory or a web directory.
  - getJarURL
```
public static java.net.URL getJarURL(java.lang.Class<?> aClass)
```
    Compute a URL that will access the jar holding a given class. (Based on http://stackoverflow.com/a/12733172/1614775)
```
      To access a file -name- in the returned jarURL
              URLClassLoader urlLoad = new URLClassLoader(jarURL);
              urlLoad.getResource...(name);
          where name is slash-separated and lacks an initial slash.
      To access a sibling of the jar, let's say "sib.ext"
          URL jarDir = jarURLtoJarParent(jarURL);
          URL sibURL = jarDir.toURI().resolve("sib.ext").toURL();
      (
          if "sib.ext" can be known to have no characters that need quoting:
          URL sibURL = new URL(jarDir, "sib.ext");
      )
```
    Parameters:
    
    aClass - A class residing in the required jar.
    
    Returns:
    
    A URL for either a jar file or a directory containing all the class files. As a special cases, if the directory would be .../build/classes/, it is converted to .../build/. Items that will be placed in the jardir by installXxxx.jar should be installed for testing in ./build, the directory containing what will be in the jar.
  - classURL
```
public static java.net.URL classURL(java.lang.Object obj)
```
    Produce a jar: URL for a member's class.The jar format is jar:{.jar file's URL}!/dir/dir/classname.class where the /dir/dir elements are the names in the class's binary name.
    
    Parameters:
    
    obj - the Class whose jar is to be found or an object whose Class will be found
    
    Returns:
    
    a "jar:" URL for the class; or null for failure
  - getPrefixFilter
```
public static FilenameFilter getPrefixFilter(java.lang.String nameStart)
```
    Produce a FilenameFilter that checks that the name starts with a given prefix.
    
    Parameters:
    
    nameStart - The prefix to look for.
    
    Returns:
    
    A suitable FileNameFilter, as described above.
  - getAcceptAllFilter
```
public static FilenameFilter getAcceptAllFilter()
```
    Produce a FilenameFilter that accepts all files
    
    Returns:
    
    A suitable FilenameFilter, as described above.
  - saveAnyOldVersion
```
public static File saveAnyOldVersion(File f)
```
    If an old version of the file exists, move it to xxx-old.txt
    
    Parameters:
    
    f - The file to be moved if it exists.
    
    Returns:
    
    The new name of the moved file. If the rename failed, the original file argument is returned.
  - getWritableFile
```
public static File getWritableFile(java.lang.String name)
```
    Given a name, return a File that is at that name and is writeable. The directories will be created. If the file did not exist, it will be created as an empty file.
    
    Parameters:
    
    name - file path. If relative, will be relative to current directory.
    
    Returns:
    
    A File for the new file, or null for failure;
  - writeWholeString
```
public static void writeWholeString(File f,
                                    java.lang.String s)
                             throws IOException
```
    Write a String to be the contents of a file. Encoding UTF-8.
    
    Parameters:
    
    f - the File to be written. An existing file will NOT be overwritten.
    
    s - the String to be written to f
    
    Throws:
    
    IOException - if it occurs
  - loadImageResource
```
public static java.awt.Image loadImageResource(java.lang.Class<?> app,
                                               java.lang.String name)
```
    Load a resource as an Image. It will be a BufferedImage.
    
    Parameters:
    
    app - An class from the same jar as the image.
    
    name - The name of the image.
    
    Returns:
    
    The image or null for failure
  - loadIconResource
```
public static javax.swing.Icon loadIconResource(java.lang.Class<?> app,
                                                java.lang.String name)
```
    Load a resource as an Icon (in fact, an ImageIcon).
    
    Parameters:
    
    app - An class from the same jar as the icon's image.
    
    name - The name of the icon image.
    
    Returns:
    
    The icon or null for failure
  - loadImage
```
public static java.awt.image.BufferedImage loadImage(java.lang.Class<?> app,
                                                     java.lang.String name)
```
    Load an Image as named by an IOUtils locator.
    
    Parameters:
    
    app - An class from the same jar as the image.
    
    name - An IOUtils locator for the image to be loaded.
    
    Returns:
    
    The image or null for failure
  - loadIcon
```
public static javax.swing.ImageIcon loadIcon(java.lang.Class<?> app,
                                             java.lang.String name)
```
    Load an image and make an ImageIcon from it.
    
    Parameters:
    
    app - An class from the same jar as the icon's image.
    
    name - An IOUtils locator for the image to be loaded.
    
    Returns:
    
    An ImageIcon wrapping the image. Or null for failure
  - exec
```
public static java.util.ArrayList<java.lang.String> exec(java.lang.String name,
                                                         java.lang.String cmd)
```
    Execute a shell command and return the output. Does not return until the command is completed. Stderr is sent to Message.beep. The maximum time allowed for execution is 20 seconds.
    
    Parameters:
    
    name - a name to appear in error messages
    
    cmd - - the command to execute. NOTE: The shell is platform dependent. On Windows it is 'cmd'; unix commands will fail.
    
    Returns:
    
    the lines produced by the command (stdout).
  - exec
```
public static java.util.ArrayList<java.lang.String> exec(java.lang.String name,
                                                         long maxTime,
                                                         java.lang.String cmd)
```
    Execute a shell command and return the output.Does not return until the command is completed. Stderr is sent to Message.beep.
    
    Parameters:
    
    name - a name to appear in error messages
    
    maxTime - maximum time (in seconds) allowed for execution. 0 means no maximum
    
    cmd - - the command to execute
    
    Returns:
    
    the lines produced by the command (stdout).
  - exec
```
public static java.util.ArrayList<java.lang.String> exec(java.lang.String name,
                                                         long maxTime,
                                                         java.lang.String cmd,
                                                         java.util.function.Consumer<java.lang.String> err)
```
    Execute a shell command and return the output. Does not return until the command is completed. Stderr is sent to a Consumer.
    
    Parameters:
    
    name - a name to appear in error message
    
    maxTime - maximum time (in seconds) allowed for execution. 0 means no maximum
    
    cmd - the command to execute
    
    err - what to do with error messages. Example: (s)->Messages.beep("something " + s)
    
    Returns:
    
    the lines produced by the command (via its stdout).
  - readWholeFile
```
public static java.lang.String readWholeFile(java.lang.String name)
                                      throws IOException
```
    Read a named file in its entirety. Uses HybridUTF8 charset. Converts newlines to \n.
    
    Parameters:
    
    name - Name of file.
    
    Returns:
    
    String of the file contents. Newlines have been converted to \n.
    
    Throws:
    
    IOException - error reading file
  - readWholeFile
```
public static java.lang.String readWholeFile(File f)
                                      throws IOException
```
    Read a File in its entirety. No input object is left open. Uses HybridUTF8 Charset. Converts newlines to \n.
    
    Parameters:
    
    f - The File to read,
    
    Returns:
    
    String of the file contents.
    
    Throws:
    
    IOException - error reading file
  - readWholeFile
```
public static java.lang.String readWholeFile(InputStream is)
                                      throws IOException
```
    Read an InputStream in its entirety. No input object is left open. Uses HybridUTF8 Charset. Converts newlines to \n. Suitable for reading from the result of getInputStream.
    
    Parameters:
    
    is - The InputStream.
    
    Returns:
    
    String of the file contents.
    
    Throws:
    
    IOException - error reading file
  - readWholeFile
```
public static java.lang.String readWholeFile(Reader rdr)
                                      throws IOException
```
    Read the entire contents of a Reader. Converts newlines to \n. No input object is left open. Suitable to reading from the result of getReader.
    
    Parameters:
    
    rdr - the Reader for the input.
    
    Returns:
    
    String of the file contents.
    
    Throws:
    
    IOException - error reading file
  - readWholeFile
```
public static java.lang.String readWholeFile(BufferedReader brdr)
                                      throws IOException
```
    Read the entire contents of a BufferedReader. Converts newlines to \n.
    
    Parameters:
    
    brdr - The BufferedReader to be read. After reading, the reader is CLOSED.
    
    Returns:
    
    String of the file contents. All lines (including the last) are terminated with a newline.
    
    Throws:
    
    IOException - error reading file
  - getInputStream
```
public static IOUtils.InfoInputStream getInputStream(java.lang.Class<?> aClass,
                                                     java.lang.String src)
```
    Get a InputStream given a source specification. Intended to give users maximum flexibility in specify the source of data.
    Supported src String formats:
    The string after userhome: jardir: or asset: is relative. An initial slash is ignored.
    
    resource:pathwithinjar
    
    look among the jar files (or in build/classes in netbeans) If no initial slash, path is relative to the package dir If initial slash, path is relative to the top of the jar. Sets sourceURL, not localFile.
    
    userhome:filepath
    
    file is getProperty("user.home")+"/"+filepath, Sets localFile, not sourceURL.
    
    ~/filepath
    
    same as userhome:filepath
    
    data:,xxxxx
    
    text lines are embedded in xxxxx
    
    jardir:filepath
    
    a file in the same directory as the jar. Sets localFile, not sourceURL.
    
    asset:[packagename/]assetname.extension
    uses the asset strategies to find the file Assets. The package name is the dotted class name of the class where the asset is defined. The default packagename is that of the aClass parameter. Asset returns an InfoInputStream set appropriately
    scheme:rest-of-uri
    
    a URI such as http://...
    the data is fetched via the scheme May set sourceURL, never localFile.
    
    other
    
    local file name; absolute or relative to current directory. // TODO NOTDOT Relative locations are unlikely to be useful. Sets localFile, not sourceURL.
    
    Parameters:
    
    src - Location of data, as described above.
    
    aClass - A Class object for a class in the application. This value is needed to find the jar and the jar directory. If null, failure is more likely.
    
    Returns:
    
    An InfoInputStream for success or null for any failure.
  - locatorFile
```
public static File locatorFile(java.lang.Class<?> aClass,
                               java.lang.String src)
```
    Parse a locator to get the corresponding file, if any. Works only for file, file:, userhome:, jardir:, and asset:.
    
    Parameters:
    
    aClass - A Class object for a class in the application. This value is needed to find the jar and the jar directory. It is also the default class for an asset: value. If null and the value is needed, the function returns null.
    
    src - The locator to parse. To denote just a directory, the last character in the file should be a slash.
    
    Returns:
    
    A File denoting the target of the locator, if posssible. Otherwise null.
  - getReader
```
public static Reader getReader(java.lang.Class<?> aClass,
                               java.lang.String src)
```
    Get a Reader as described by a scheme. Call getInputStream to get a stream and then construct a reader on it. Default Hybrid-UTF-8
    
    Parameters:
    
    src - Input location as described for getInputStream
    
    aClass - A Class object for a class in the application. This value is needed to find the jar and the jar directory. If null, function returns null.
    
    Returns:
    
    A Reader for success or null for any failure.
  - getReader
```
public static Reader getReader(java.lang.Class<?> aClass,
                               IOUtils.InfoInputStream iis)
```
    Get a Reader as described by a scheme. Call getInputStream to get a stream and then construct a reader on it. Default Hybrid-UTF-8
    
    Parameters:
    
    iis - An InfoIputStream to read from.
    
    aClass - A Class object for a class in the application. This value is needed to find the jar and the jar directory. If null, function returns null.
    
    Returns:
    
    A Reader for success or null for any failure.
  - checkCharset
```
public static java.nio.charset.Charset checkCharset(java.lang.String name)
```
    Checks if there is a charset for a given name.
    
    Parameters:
    
    name - Name of desired charset.
    
    Returns:
    
    The desired Charset, or null if it isn't
  - getMimeForExt
```
public static java.lang.String getMimeForExt(java.lang.String ext)
```
  - putMimeForExt
```
public static void putMimeForExt(java.lang.String ext,
                                 java.lang.String mime)
```
  - getParserForMime
```
public static IOUtils.StreamToObject getParserForMime(java.lang.String mime)
```
    Given a mime type, returns an appropriate parser.
    
    Parameters:
    
    mime - A mimetype of the form basis/specific, where the basis is one of application, audio, text, or image.
    
    Returns:
    
    A parser for the type. If there is no registered parser for the full type, a parser is found for the basis. If no parser is found, returns null. The client is expected to default null to parser OCTET_PARSER.
  - putParserForMime
```
public static void putParserForMime(java.lang.String mime,
                                    IOUtils.StreamToObject parser)
```
  - fetchFromLocator
```
public static java.lang.Object fetchFromLocator(java.lang.Class<?> aClass,
                                                java.lang.String src,
                                                java.lang.Object sample)
```
    Read from an URL with parameters and produce an appropriate Object: String, JEditorPane, org.w3c.dom.Document, Image, byte[] The parameters depend on type
    Parameters:
    
    aClass - the Class required for locators with schemes resource: and jardir:. May be null if these schemes are not to be used; but this risks NullPointer exceptions.
    
    src - the URL source for the object
    sample - depends on expected type to arrive on the URL. The type of sample is a fallback mechanism for determining the type of the expected result.
    for a text, String; null = HYBRID-UTF-8 string content may be charset name for byte[], may be a Byte object for xml, DocumentBuilder; null = newDocumentBuilder() parameters of the DocumentBuilder may be set in the DocumentBuilderFactory before creating the DocumentBuilder for audio, AudioAsset, possibly with format set; null = {get format from the stream} (best if left at null) for image, an Image to suggest that result will be an image for jed, an JEditorPane destination for the parse charset is via getClientProperty("charset") if mimetype is not apparent in the stream, use type of editorkit sample and default: text/html; charset=HYBRID-UTF-8 otherwise it creates a new JeditorPane
    Returns:
    
    the Object constructed by reading from the URL
  - bytesToHex
```
public static java.lang.String bytesToHex(byte[] bytes)
```
    Convert an array of bytes to a mixed string. Characters in range 0x20... 0x7F are shown as themselves; other characters are shown as two hex bytes.
    
    Parameters:
    
    bytes - the input
    
    Returns:
    
    A string as described above. The pairs of hex values are separated with spaces.
  - getComponentFor
```
public static javax.swing.JComponent getComponentFor(java.lang.Object obj)
```
    Get a viewer for one of the objects returned by fetchAsset
    
    Parameters:
    
    obj - An Object. especially one that can be viewed by a JComponent.
    
    Returns:
    
    A JComponent that is viewing the object. If object is not viewable, the result is a JLabel displaying a message.
  - showObject
```
public static void showObject(java.lang.String title,
                              javax.swing.JComponent comp)
```

Class IOUtils

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CYGWIN_ROOT

workDir

SCHEME_PAT

URI_PAT

SCHEME

SLASHES

RELPATH

QUERY

DATA_PAT

MIMETYPE

MIMEPARAMS

DATA

EXTENSION_TO_MIME

HEX_ARRAY

Constructor Detail

IOUtils

Method Detail

setWorkDir

getWorkDir

getDIR_WEBROOT

getDIR_JAVAROOT

getDIR_PICTOOLS

getDIR_HOME

getPHYSPICS_INI_DIR

printRootDirectories

browse

browse

browse

capitalizeDriveLetter

valueForFinalDir

dirFromEnv

extension

extension

newExtension

newExtension

stemname

stemname

stemname

stemname

basename

basename

basename

dirname

f2U

relativize

relativize

relativize

absolutize

absolutize

absolutize

canonicalize

nativize

nativize

fileToUnix

getSibling

jarURLtoJarParent

jarFile

jarDir

jarDirURL

getJarURL

classURL

getPrefixFilter

getAcceptAllFilter

saveAnyOldVersion

getWritableFile

writeWholeString

loadImageResource

loadIconResource

loadImage

loadIcon

exec

exec

exec