JTFTools (acm 2.1 API)

java.lang.Object
- acm.util.JTFTools

```
public class JTFTools
extends java.lang.Object
```
This class provides a collection of static utility methods that are used elsewhere in the ACM packages.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`checkIfLoaded(java.lang.String className)` Returns true if the specified class is already loaded.
`static void`	`copyBytes(java.io.InputStream in, java.io.OutputStream out, long nBytes)` Copies the specified number bytes from the input stream to the output stream.
`static void`	`copyFile(java.io.File oldFile, java.io.File newFile)` Copies a file from `oldFile` to `newFile`.
`static java.awt.Container`	`createEmptyContainer()` Returns an empty lightweight container.
`static java.awt.Color`	`decodeColor(java.lang.String name)` Decodes a color name.
`static java.awt.Font`	`decodeFont(java.lang.String str)` Decodes a font in the style of `Font.decode`.
`static java.awt.Font`	`decodeFont(java.lang.String str, java.awt.Font oldFont)` Decodes a font in the style of `Font.decode`.
`static java.lang.String`	`findFontFamily(java.lang.String str)` Finds the first font family in the string `str` that exists in the current `GraphicsEnvironment`.
`static java.lang.String`	`getCommandLine()` Returns the command line that invoked this program, or `null` if no command line is available.
`static java.awt.Frame`	`getEnclosingFrame(java.awt.Component comp)` Returns the frame that encloses the specified component.
`static java.lang.String[]`	`getFontList()` Returns an array of the available font family names.
`static java.lang.String`	`getLocalHostName()` Returns the canonical name of the local host.
`static java.lang.String`	`getMainClass()` Returns the name of the main class.
`static java.awt.Font`	`getStandardFont(java.awt.Font font)` Returns a font that will approximate the specified font in this environment.
`static boolean`	`isAnonymous(java.lang.Thread t)` Returns `true` if the supplied thread is an anonymous one created automatically by the system.
`static boolean`	`matchFilenamePattern(java.lang.String filename, java.lang.String pattern)` Determines whether the filename matches the specified pattern.
`static java.io.OutputStream`	`openBase64OutputStream(java.io.PrintStream printStream)` Opens an output stream that allows the client to write data using Base64 encoding, which is the most common encoding for mail attachments.
`static java.io.OutputStream`	`openHexByteOutputStream(java.io.PrintStream printStream)` Opens an output stream that allows the client to write data using pairs of hex characters.
`static void`	`padBase64OutputStream(java.io.OutputStream out)` Pads the data in the specified output stream without closing it.
`static void`	`pause(double milliseconds)` Delays the calling thread for the specified time, which is expressed in milliseconds.
`static void`	`setDebugOptions(java.lang.String options)` Sets the debugging options in place for this run.
`static boolean`	`testDebugOption(java.lang.String option)` Tests to see whether the current program was invoked with a `debug` parameter that contains the specified string as a lexical unit in a string delimited by `+` signs.

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

- Method Detail
  - pause
```
public static void pause(double milliseconds)
```
    Delays the calling thread for the specified time, which is expressed in milliseconds. Unlike Thread.sleep, this method never throws an exception.
    
    Parameters:
    
    milliseconds - The sleep time in milliseconds
  - createEmptyContainer
```
public static java.awt.Container createEmptyContainer()
```
    Returns an empty lightweight container. Several packages need to create such components as placeholders. Defining it in JTFTools gives those pacakges access to a common mechanism.
    
    Returns:
    
    An empty lightweight container that can be used as a placeholder
  - getEnclosingFrame
```
public static java.awt.Frame getEnclosingFrame(java.awt.Component comp)
```
    Returns the frame that encloses the specified component.
    
    Parameters:
    
    comp - The component at which to start the search
    
    Returns:
    
    The nearest enclosing Frame object
  - getStandardFont
```
public static java.awt.Font getStandardFont(java.awt.Font font)
```
    Returns a font that will approximate the specified font in this environment. This method is required because some browsers do not support the standard fonts Serif, SansSerif, and Monospaced.
    
    Parameters:
    
    font - The font being checked
    
    Returns:
    
    The new font
  - getFontList
```
public static java.lang.String[] getFontList()
```
    Returns an array of the available font family names.
    
    Returns:
    
    An array of the available font family names
  - findFontFamily
```
public static java.lang.String findFontFamily(java.lang.String str)
```
    Finds the first font family in the string str that exists in the current GraphicsEnvironment. As in HTML font tags, the str consists of a set of font names separated by semicolons. The findFontFamily method returns the first family name that exists in the list of loaded fonts, or null if there are none.
    
    Parameters:
    
    str - The list of family names separated by semicolons
    
    Returns:
    
    The first family name that exists, or null if none
  - decodeFont
```
public static java.awt.Font decodeFont(java.lang.String str)
```
    Decodes a font in the style of Font.decode.
    
    Parameters:
    
    str - The string to decode
    
    Returns:
    
    The new font
  - decodeFont
```
public static java.awt.Font decodeFont(java.lang.String str,
                                       java.awt.Font oldFont)
```
    Decodes a font in the style of Font.decode. The only difference is that this method takes a font parameter that gives default values for the different parts of the font. If the family, size, or style is specified as an asterisk, the corresponding value is taken from the supplied font.
    
    Parameters:
    
    str - The string to decode
    
    oldFont - The font whose properties are used as defaults
    
    Returns:
    
    The new font
  - decodeColor
```
public static java.awt.Color decodeColor(java.lang.String name)
```
    Decodes a color name. This method is similar to Color.decode except in that it allows named colors and system colors.
    
    Parameters:
    
    name - The string name of the color
    
    Returns:
    
    The color corresponding to the specified name
  - matchFilenamePattern
```
public static boolean matchFilenamePattern(java.lang.String filename,
                                           java.lang.String pattern)
```
    Determines whether the filename matches the specified pattern. The pattern string is interpreted in much the same way that a Unix shell expands filenames and supports the following wildcard options:
    
    ? Matches any single character
    
    * Matches any sequence of characters
    
    [...] Matches any of the specified characters
    
    [^...] Matches any character except the specified ones
    
    The last two options allow a range of characters to be specified in the form a-z.
    
    Parameters:
    
    filename - The filename being tested
    
    pattern - The pattern including wildcards
    
    Returns:
    
    true if the filename matches the pattern
  - setDebugOptions
```
public static void setDebugOptions(java.lang.String options)
```
    Sets the debugging options in place for this run. The list of options are a set of strings combined with the + sign character.
    
    Parameters:
    
    options - The names of the enabled options separated by plus signs
  - testDebugOption
```
public static boolean testDebugOption(java.lang.String option)
```
    Tests to see whether the current program was invoked with a debug parameter that contains the specified string as a lexical unit in a string delimited by + signs.
    
    Parameters:
    
    option - The name of the option
    
    Returns:
    
    The constant true if the specified debug option is in effect
  - getCommandLine
```
public static java.lang.String getCommandLine()
```
    Returns the command line that invoked this program, or null if no command line is available.
    
    Returns:
    
    The command line that invoked this program
  - getMainClass
```
public static java.lang.String getMainClass()
```
    Returns the name of the main class.
    
    Returns:
    
    The name of the main class, or null if that class cannot be identified
  - checkIfLoaded
```
public static boolean checkIfLoaded(java.lang.String className)
```
    Returns true if the specified class is already loaded.
    
    Parameters:
    
    className - The name of the class
    
    Returns:
    
    The boolean value true if the class is already loaded, and false otherwise
  - isAnonymous
```
public static boolean isAnonymous(java.lang.Thread t)
```
    Returns true if the supplied thread is an anonymous one created automatically by the system.
    
    Parameters:
    
    t - The thread being tested
  - openHexByteOutputStream
```
public static java.io.OutputStream openHexByteOutputStream(java.io.PrintStream printStream)
```
    Opens an output stream that allows the client to write data using pairs of hex characters. The return value is an OutputStream that the client can use to which the client can send binary data, which is then written in encoded form to the underlying PrintStream object.
    
    Parameters:
    
    printStream - The underlying PrintStream to which data is written
    
    Returns:
    
    An OutputStream for writing binary data
  - openBase64OutputStream
```
public static java.io.OutputStream openBase64OutputStream(java.io.PrintStream printStream)
```
    Opens an output stream that allows the client to write data using Base64 encoding, which is the most common encoding for mail attachments. The return value is an OutputStream that the client can use to which the client can send binary data, which is then written in encoded form to the underlying PrintStream object. Closing the stream automatically pads the data to complete a Base64 unit. To pad the data without closing the stream (as one would need to do for a multi-attachment message, for example), call the padBase64OutputStream method.
    
    Parameters:
    
    printStream - The underlying PrintStream to which data is written
    
    Returns:
    
    An OutputStream for writing binary data
  - padBase64OutputStream
```
public static void padBase64OutputStream(java.io.OutputStream out)
```
    Pads the data in the specified output stream without closing it. This method is automatically called when the stream is closed, but must be called explicitly if you intend to write additional data to the underlying PrintStream.
    
    Parameters:
    
    out - The output stream returned by openBase64OutputStream
  - getLocalHostName
```
public static java.lang.String getLocalHostName()
```
    Returns the canonical name of the local host.
    
    Returns:
    
    The fully qualified name of the local host, or null if unavailable
  - copyFile
```
public static void copyFile(java.io.File oldFile,
                            java.io.File newFile)
```
    Copies a file from oldFile to newFile.
    
    Parameters:
    
    oldFile - A File object indicating the existing file
    
    newFile - A File object indicating the new file
  - copyBytes
```
public static void copyBytes(java.io.InputStream in,
                             java.io.OutputStream out,
                             long nBytes)
                      throws java.io.IOException
```
    Copies the specified number bytes from the input stream to the output stream.
    
    Parameters:
    
    in - The input stream
    
    out - The output stream
    
    nBytes - The number of bytes to copy
    
    Throws:
    
    java.io.IOException

`?`	Matches any single character
`*`	Matches any sequence of characters
`[...]`	Matches any of the specified characters
`[^...]`	Matches any character except the specified ones

Class JTFTools

Method Summary

Methods inherited from class java.lang.Object

Method Detail

pause

createEmptyContainer

getEnclosingFrame

getStandardFont

getFontList

findFontFamily

decodeFont

decodeFont

decodeColor

matchFilenamePattern

setDebugOptions

testDebugOption

getCommandLine

getMainClass

checkIfLoaded

isAnonymous

openHexByteOutputStream

openBase64OutputStream

padBase64OutputStream

getLocalHostName

copyFile

copyBytes