SystemUtilities (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- workbench.util.SystemUtilities

public class SystemUtilities
extends Object

Constructor Summary

Constructors
Constructor and Description

SystemUtilities()

Constructors
Constructor and Description
`SystemUtilities()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`buildPathToRunningVM()` This is done to insure that the VM executed is the same as the currently running one.
`static String`	`changeFileExt(String sFileName, String sExt)` change file extension
`static String`	`changeFileName(String sFileName, String sPrefix, String sSuffix, String sExt)` change file name + extension retain file directory
`static File[]`	`directoryList(File dir)` get the list of directories in the directory (recursive)
`static File[]`	`driveList()` list all drives/filesystem roots on my system?
`static String`	`extractDirectory(String strFile)` Returns the name of the file or directory denoted by this abstract pathname.
`static String`	`extractFileDirectory(String sPath)` extract the file directory e.g. 1. orange.svg -> EMPTY 2. http://server/directory/apple.svg -> http://server/directory/ 3. file:\\c:\durian.svg -> file:\\c:\
`static String`	`extractFileName(String sFileName)` extract filename without directory information e.g. 1. orange.svg -> orange.svg 2. http://server/directory/apple.svg -> apple.svg 3. file:\\c:\durian.svg -> durian.svg
`static String`	`extractFileNameFromURL(String strFile)` Returns the name of the file or directory denoted by this abstract pathname.
`static String`	`extractFileNameOnly(String sFileName)` extract filename without file extension and directory information e.g. 1. orange.svg -> orange 2. http://server/directory/apple.svg -> apple 3. file:\\c:\durian.svg -> durian
`static String`	`extractHostDir(String sURL)` extract the directory from URL or FTP address 1. http://serverAAA/directory/apple.svg -> directory/ 2. http://serverAAA/directory/123/apple.svg -> directory/123/
`static boolean`	`fileCanZip(String name)` determine whether type of file can be zipped based on file extension
`static boolean`	`filecopy(File from, File to)` file copy
`static boolean`	`filecopy(String sFrom, String sTo)` file copy (Filenames)
`static boolean`	`filecopy(String sFrom, String sTo, int offset, int len)` file copy (Filenames)
`static byte[]`	`fileRead(String filename)` read byte array data from source file
`static long`	`fileSize(String filename)` get file size
`static boolean`	`fileWrite(String filename, String data)` write byte array data to a file
`static String`	`getContentTypeFromName(String filename)` generate the MIME type for a specified filename based on file extension
`static String`	`getDateTime()` get date time in a useful string e.g. date=15 Jan 2003, time=15:40:12 returns 20030115154012 + timezone
`static String`	`getDateTime14()` get date time in a 14-character string e.g. date=15 Jan 2003, time=15:40:12 returns 20030115154012 + timezone
`static String`	`getDateTime8()` get date time in a 8-character string e.g. date=15 Jan 2003 returns 20030115
`static String[]`	`getFiles(String sDir, String sExt)` get list of files from a directory
`static int[]`	`getPixels(Image parImage, int parWidth, int parHeight)` get array of pixels, invoked by loadBitmap
`static int`	`HexToInt(String s)` convert hex to int
`static String`	`ipHashToStr(int iHashcode)` convert a hash value into a 4 dotted decimal
`static Image`	`loadBitmap(String sfile)` loading bitmaps Modified "Java Tip 43: How to read 8- and 24-bit Microsoft Windows bitmaps in Java applications" Also see "List of Java libraries to read and write image files" http://www.geocities.com/marcoschmidt.geo/java-image-coding.html
`static String`	`pad(int size, String symbol)` pad - create a padded string with symbol (adapted from Chapter 6 of Introduction to OOP by Thomas Otani)
`static Color`	`parseHtmlColor(String s)` Convert HTML color value (format "#RRGGBB" where RR, GG, and BB are hexadecimal values) to Java Color object.
`static String`	`propertyLoad(String filename, String entry, String default_value)` read an entry value from a property/INI file e.g.
`static boolean`	`propertyStore(String filename, String header, String entry, String value)` save an entry value from a property/INI file e.g.
`static boolean`	`screenCapture(String sFileName)` perform screen capture (entire screen, part of a screen using rectangle/dimension)
`static boolean`	`screenCapture(String sFileName, Component c)` This utility method does the actual screencapture of the OpenMap and 2D Mission views
`static boolean`	`screenCapture(String sFileName, Dimension scrDimen)` perform screen capture (entire screen, part of a screen using rectangle/dimension)
`static boolean`	`screenCapture(String sFileName, int scrX, int scrY, int scrWidth, int scrHeight)` perform screen capture (entire screen, part of a screen using rectangle/dimension)
`static boolean`	`screenCapture(String sFileName, Rectangle scrRect)` perform screen capture (entire screen, part of a screen using rectangle/dimension)
`static boolean`	`screenCapture(String sFileName, Rectangle scrRect, String typ)`
`static boolean`	`screenCapture(String sFileName, String typ)`
`static void`	`sysOutPrint(char c)`
`static void`	`sysOutPrint(String s)`
`static void`	`sysOutPrintln(String s)` Provide synchronized methods for multiple threads to use single run-time messages panel.

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

- Constructor Detail
  - SystemUtilities
```
public SystemUtilities()
```
- Method Detail
  - buildPathToRunningVM
```
public static String buildPathToRunningVM()
```
    This is done to insure that the VM executed is the same as the currently running one. If the AUVW is launched with an explicit path to a VM whose "java" executable is not on the standard OS path, the mission will be executed on a different one.
    
    Returns:
    path to JVM executable to be used in Runtime.exec().
  - driveList
```
public static File[] driveList()
```
    list all drives/filesystem roots on my system? e.g. File[] roots = driveList( );
    
    Returns:
    File[] representing just the directories
  - directoryList
```
public static File[] directoryList(File dir)
```
    get the list of directories in the directory (recursive)
    
    Parameters:
    dir - to search
    
    Returns:
    File[] representing just the directories e.g. String sDir = "C:\\temp\\"; File[] dirs = SystemUtilities.directoryList( new File(sDir) ); for (int k=0; k
  - extractDirectory
```
public static String extractDirectory(String strFile)
```
    Returns the name of the file or directory denoted by this abstract pathname. This is just the last name in the pathname's name sequence. If the pathname's name sequence is empty, then the empty string is returned.
    
    Parameters:
    strFile - URL
    
    Returns:
    The name of the file or directory denoted by this abstract pathname, or the empty string if this pathname's name sequence is empty
  - extractFileNameFromURL
```
public static String extractFileNameFromURL(String strFile)
```
    Returns the name of the file or directory denoted by this abstract pathname. This is just the last name in the pathname's name sequence. If the pathname's name sequence is empty, then the empty string is returned.
    
    Parameters:
    strFile - URL
    
    Returns:
    The name of the file or directory denoted by this abstract pathname, or the empty string if this pathname's name sequence is empty
  - extractFileName
```
public static String extractFileName(String sFileName)
```
    extract filename without directory information e.g. 1. orange.svg -> orange.svg 2. http://server/directory/apple.svg -> apple.svg 3. file:\\c:\durian.svg -> durian.svg
    
    Parameters:
    sFileName - filename
    
    Returns:
    extractd filename
  - extractFileNameOnly
```
public static String extractFileNameOnly(String sFileName)
```
    extract filename without file extension and directory information e.g. 1. orange.svg -> orange 2. http://server/directory/apple.svg -> apple 3. file:\\c:\durian.svg -> durian
    
    Parameters:
    sFileName - filename
    
    Returns:
    extractd filename
  - extractFileDirectory
```
public static String extractFileDirectory(String sPath)
```
    extract the file directory e.g. 1. orange.svg -> EMPTY 2. http://server/directory/apple.svg -> http://server/directory/ 3. file:\\c:\durian.svg -> file:\\c:\
    
    Parameters:
    sPath - file path
    
    Returns:
    extracted file directory
  - extractHostDir
```
public static String extractHostDir(String sURL)
```
    extract the directory from URL or FTP address 1. http://serverAAA/directory/apple.svg -> directory/ 2. http://serverAAA/directory/123/apple.svg -> directory/123/
    
    Parameters:
    sURL - file path
    
    Returns:
    extracted file directory
  - changeFileExt
```
public static String changeFileExt(String sFileName,
                   String sExt)
```
    change file extension
    
    Parameters:
    sFileName - filename
    sExt - file extension to be changed
    
    Returns:
    filename with extension replaced
  - changeFileName
```
public static String changeFileName(String sFileName,
                    String sPrefix,
                    String sSuffix,
                    String sExt)
```
    change file name + extension retain file directory
    
    Parameters:
    sFileName - filename
    sPrefix - prefix to be appended
    sSuffix - prefix to be appended
    sExt - file extension to be changed to
    
    Returns:
    filename with extension replaced
  - fileCanZip
```
public static boolean fileCanZip(String name)
```
    determine whether type of file can be zipped based on file extension
    
    Parameters:
    name - filename
    
    Returns:
    value
  - filecopy
```
public static boolean filecopy(File from,
               File to)
```
    file copy
    
    Parameters:
    from - source file
    to - destination file
    
    Returns:
    status
  - filecopy
```
public static boolean filecopy(String sFrom,
               String sTo)
                        throws IOException
```
    file copy (Filenames)
    
    Parameters:
    sFrom - input filename
    sTo - output filename
    
    Returns:
    status
    
    Throws:
    
    IOException - failure
  - filecopy
```
public static boolean filecopy(String sFrom,
               String sTo,
               int offset,
               int len)
                        throws IOException
```
    file copy (Filenames)
    
    Parameters:
    sFrom - source file
    sTo - destination file
    offset - offset
    len - length
    
    Returns:
    status
    
    Throws:
    
    IOException - failure
  - fileRead
```
public static byte[] fileRead(String filename)
                       throws IOException
```
    read byte array data from source file
    
    Parameters:
    filename - source file to be read from
    
    Returns:
    byte array
    
    Throws:
    
    IOException - IO exception error
  - fileSize
```
public static long fileSize(String filename)
```
    get file size
    
    Parameters:
    filename - file name
    
    Returns:
    size of file
  - fileWrite
```
public static boolean fileWrite(String filename,
                String data)
                         throws IOException
```
    write byte array data to a file
    
    Parameters:
    filename - destination file
    data - write byte array data to file
    
    Returns:
    true for successful, otherwise false
    
    Throws:
    
    IOException - IO exception error
  - getDateTime14
```
public static String getDateTime14()
```
    get date time in a 14-character string e.g. date=15 Jan 2003, time=15:40:12 returns 20030115154012 + timezone
    
    Returns:
    a String value
  - getDateTime
```
public static String getDateTime()
```
    get date time in a useful string e.g. date=15 Jan 2003, time=15:40:12 returns 20030115154012 + timezone
    
    Returns:
    a String value
  - getDateTime8
```
public static String getDateTime8()
```
    get date time in a 8-character string e.g. date=15 Jan 2003 returns 20030115
    
    Returns:
    a String value
  - getFiles
```
public static String[] getFiles(String sDir,
                String sExt)
```
    get list of files from a directory
    
    Parameters:
    sDir - directory name
    sExt - file extension filter (case insensitive)
    
    Returns:
    list of files in directory
  - getContentTypeFromName
```
public static String getContentTypeFromName(String filename)
```
    generate the MIME type for a specified filename based on file extension
    
    Parameters:
    filename - name of file
    
    Returns:
    value
  - ipHashToStr
```
public static String ipHashToStr(int iHashcode)
```
    convert a hash value into a 4 dotted decimal
    
    Parameters:
    iHashcode - IP address as Integer
    
    Returns:
    dotted decimal
  - loadBitmap
```
public static Image loadBitmap(String sfile)
```
    loading bitmaps Modified "Java Tip 43: How to read 8- and 24-bit Microsoft Windows bitmaps in Java applications" Also see "List of Java libraries to read and write image files" http://www.geocities.com/marcoschmidt.geo/java-image-coding.html
    
    Parameters:
    sfile - bitmap file to be loaded
    
    Returns:
    Image Object
  - getPixels
```
public static int[] getPixels(Image parImage,
              int parWidth,
              int parHeight)
```
    get array of pixels, invoked by loadBitmap
    
    Parameters:
    parImage - image
    parWidth - width of image
    parHeight - height of image
    
    Returns:
    integer array
  - parseHtmlColor
```
public static Color parseHtmlColor(String s)
```
    Convert HTML color value (format "#RRGGBB" where RR, GG, and BB are hexadecimal values) to Java Color object.
    
    Parameters:
    s - HTML hex string value
    
    Returns:
    a color
  - HexToInt
```
public static int HexToInt(String s)
```
    convert hex to int
    
    Parameters:
    s - hex string
    
    Returns:
    numeric value
  - pad
```
public static String pad(int size,
         String symbol)
```
    pad - create a padded string with symbol (adapted from Chapter 6 of Introduction to OOP by Thomas Otani)
    
    Parameters:
    size - size of padding
    symbol - symbol to be padded with
    
    Returns:
    padded string
  - propertyLoad
```
public static String propertyLoad(String filename,
                  String entry,
                  String default_value)
```
    read an entry value from a property/INI file e.g. #Brownie #Sat May 17 10:02:00 MST 2003 mini=hello world entry='mini', value='hello world'
    
    Parameters:
    filename - property/INI file
    entry - entry to be read
    default_value - default value if no entry found
    
    Returns:
    value
  - propertyStore
```
public static boolean propertyStore(String filename,
                    String header,
                    String entry,
                    String value)
```
    save an entry value from a property/INI file e.g. #Brownie #Sat May 17 10:02:00 MST 2003 mini=hello world entry='mini', value='hello world'
    
    Parameters:
    filename - property/INI file
    header - comments at the top of the property file
    entry - entry to be stored
    value - value to be stored
    
    Returns:
    status
  - screenCapture
```
public static boolean screenCapture(String sFileName)
```
    perform screen capture (entire screen, part of a screen using rectangle/dimension)
    
    Parameters:
    sFileName - location to store screen capture
    
    Returns:
    status
  - screenCapture
```
public static boolean screenCapture(String sFileName,
                    String typ)
```
  - screenCapture
```
public static boolean screenCapture(String sFileName,
                    Dimension scrDimen)
```
    perform screen capture (entire screen, part of a screen using rectangle/dimension)
    
    Parameters:
    sFileName - location to store screen capture
    scrDimen - screen capture size defined as Dimension
    
    Returns:
    status
  - screenCapture
```
public static boolean screenCapture(String sFileName,
                    int scrX,
                    int scrY,
                    int scrWidth,
                    int scrHeight)
```
    perform screen capture (entire screen, part of a screen using rectangle/dimension)
    
    Parameters:
    sFileName - location to store screen capture
    scrX - location X
    scrY - location Y
    scrWidth - width
    scrHeight - height
    
    Returns:
    status
  - screenCapture
```
public static boolean screenCapture(String sFileName,
                    Rectangle scrRect)
```
    perform screen capture (entire screen, part of a screen using rectangle/dimension)
    
    Parameters:
    sFileName - location to store screen capture
    scrRect - screen capture size defined as Rectangle
    
    Returns:
    status
  - screenCapture
```
public static boolean screenCapture(String sFileName,
                    Rectangle scrRect,
                    String typ)
```
  - screenCapture
```
public static boolean screenCapture(String sFileName,
                    Component c)
```
    This utility method does the actual screencapture of the OpenMap and 2D Mission views
    
    Parameters:
    sFileName - the name of the PNG file to write the image to
    c - the component to paint for the image capture
    
    Returns:
    indication of success of screencapture
  - sysOutPrintln
```
public static void sysOutPrintln(String s)
```
    Provide synchronized methods for multiple threads to use single run-time messages panel.
    
    Parameters:
    s -
  - sysOutPrint
```
public static void sysOutPrint(String s)
```
  - sysOutPrint
```
public static void sysOutPrint(char c)
```

Class SystemUtilities

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SystemUtilities

Method Detail

buildPathToRunningVM

driveList

directoryList

extractDirectory

extractFileNameFromURL

extractFileName

extractFileNameOnly

extractFileDirectory

extractHostDir

changeFileExt

changeFileName

fileCanZip

filecopy

filecopy

filecopy

fileRead

fileSize

fileWrite

getDateTime14

getDateTime

getDateTime8

getFiles

getContentTypeFromName

ipHashToStr

loadBitmap

getPixels

parseHtmlColor

HexToInt

pad

propertyLoad

propertyStore

screenCapture

screenCapture

screenCapture

screenCapture

screenCapture

screenCapture

screenCapture

sysOutPrintln

sysOutPrint

sysOutPrint