edu.udo.cs.yale.tools
Class Tools

java.lang.Object
  edu.udo.cs.yale.tools.Tools

public class Tools
extends java.lang.Object

Tools for YALE.

Version:

$Id: Tools.java,v 2.46 2006/09/25 14:28:49 ingomierswa Exp $

Author:

Simon Fischer, Ingo Mierswa

Field Summary

private static java.util.List<ResourceSource>	ALL_RESOURCES
static java.lang.String[]	FALSE_STRINGS
private static java.text.NumberFormat	NUMBER_FORMAT Used for formatting values in the formatNumber(double) method.
private static java.text.NumberFormat	PERCENT_FORMAT Used for formatting values in the formatPercent(double) method.
static java.lang.String[]	TRUE_STRINGS

Constructor Summary

Tools()

Method Summary

static void	addResourceSource(ResourceSource source) Adds a new resource source.
static boolean	booleanValue(java.lang.String string, boolean deflt)
static java.lang.Class	classForName(java.lang.String className)
static java.lang.String	classNameWOPackage(java.lang.Class c) Returns the class name of the given class without the package information.
static java.lang.String	escapeXML(java.lang.String string) Replaces angle brackets by html entities.
static void	findImplementationsInJar(java.lang.ClassLoader loader, java.util.jar.JarFile jar, java.lang.Class<?> superClass, java.util.List<java.lang.String> implementations)
static void	findImplementationsInJar(java.util.jar.JarFile jar, java.lang.Class superClass, java.util.List<java.lang.String> implementations)
static java.io.File	findSourceFile(java.lang.StackTraceElement e)
static java.lang.String	formatIntegerIfPossible(double value) Returns a number string with no fraction digits if possible.
static java.lang.String	formatNumber(double value) Returns a formatted string of the given number (number format with usually three fraction digits).
static java.lang.String	formatNumber(double value, int numberOfDigits) Returns a formatted string of the given number (number format with three fraction digits).
static java.lang.String	formatPercent(double value) Returns a formatted string of the given number (percent format with two fraction digits).
static java.io.File	getFile(java.io.File parent, java.lang.String name) Creates a file relative to the given parent if name is not an absolute file name.
static java.io.BufferedReader	getReader(java.io.File file) This method checks if the given file is a Zip file containing one entry.
static java.lang.String	getRelativePath(java.io.File firstFile, java.io.File secondFile) Returns the relative path of the first file resolved against the second.
static java.net.URL	getResource(java.lang.String name) Returns the desired resource.
static java.lang.Process	launchFileEditor(java.io.File file, int line)
static boolean	mkdir(java.io.File dir) Creates a directory including parent directories.
static java.lang.String	ordinalNumber(int n) Returns the name for an ordinal number.
static java.lang.String	readOutput(java.io.BufferedReader in) Reads the output of the reader and delivers it at string.
static java.lang.String	readTextFile(java.io.File file)
static java.lang.String	readTextFile(java.io.Reader r)
static void	sendEmail(java.lang.String address, java.lang.String subject, java.lang.String content) Sends a mail to the given address, using the specified subject and contents.
static void	waitForProcess(Operator operator, java.lang.Process process, java.lang.String name) Waits for process to die and writes log messages.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NUMBER_FORMAT

private static final java.text.NumberFormat NUMBER_FORMAT

Used for formatting values in the formatNumber(double) method.

PERCENT_FORMAT

private static final java.text.NumberFormat PERCENT_FORMAT

Used for formatting values in the formatPercent(double) method.

ALL_RESOURCES

private static final java.util.List<ResourceSource> ALL_RESOURCES

TRUE_STRINGS

public static final java.lang.String[] TRUE_STRINGS

FALSE_STRINGS

public static final java.lang.String[] FALSE_STRINGS

Constructor Detail

Tools

public Tools()

Method Detail

formatPercent

public static java.lang.String formatPercent(double value)

Returns a formatted string of the given number (percent format with two fraction digits).

formatNumber

public static java.lang.String formatNumber(double value)

Returns a formatted string of the given number (number format with usually three fraction digits).

formatNumber

public static java.lang.String formatNumber(double value,
                                            int numberOfDigits)

Returns a formatted string of the given number (number format with three fraction digits).

formatIntegerIfPossible

public static java.lang.String formatIntegerIfPossible(double value)

Returns a number string with no fraction digits if possible. Otherwise the complete digits will be returned.

ordinalNumber

public static final java.lang.String ordinalNumber(int n)

Returns the name for an ordinal number.

classNameWOPackage

public static java.lang.String classNameWOPackage(java.lang.Class c)

Returns the class name of the given class without the package information.

readOutput

public static java.lang.String readOutput(java.io.BufferedReader in)
                                   throws java.io.IOException

Reads the output of the reader and delivers it at string.

Throws:

java.io.IOException

getFile

public static java.io.File getFile(java.io.File parent,
                                   java.lang.String name)

Creates a file relative to the given parent if name is not an absolute file name. Returns null if name is null.

getReader

public static java.io.BufferedReader getReader(java.io.File file)
                                        throws java.io.IOException

This method checks if the given file is a Zip file containing one entry. If this is the case, a reader based on a ZipInputStream for this entry is returned. Otherwise, this method just returns a BufferedReader for the given file.

Throws:

java.io.IOException

mkdir

public static boolean mkdir(java.io.File dir)

Creates a directory including parent directories.

Returns:

true, if operation was successful.

getRelativePath

public static java.lang.String getRelativePath(java.io.File firstFile,
                                               java.io.File secondFile)
                                        throws java.io.IOException

Returns the relative path of the first file resolved against the second.

Throws:

java.io.IOException

waitForProcess

public static void waitForProcess(Operator operator,
                                  java.lang.Process process,
                                  java.lang.String name)
                           throws OperatorException

Waits for process to die and writes log messages. Terminates if exit value is not 0.

Throws:

OperatorException

sendEmail

public static void sendEmail(java.lang.String address,
                             java.lang.String subject,
                             java.lang.String content)

Sends a mail to the given address, using the specified subject and contents. Subject must contain no whitespace!

addResourceSource

public static void addResourceSource(ResourceSource source)

Adds a new resource source. Might be used by plugins etc.

getResource

public static java.net.URL getResource(java.lang.String name)

Returns the desired resource. Tries first to find a resource in the core YALE resources directory. If no resource with the given name is found, it is tried to load with help of the ResourceSource which might have been added by plugins. Please note that resource names are only allowed to use '/' as separator instead of File.separator!

readTextFile

public static java.lang.String readTextFile(java.io.File file)
                                     throws java.io.IOException

Throws:

java.io.IOException

readTextFile

public static java.lang.String readTextFile(java.io.Reader r)
                                     throws java.io.IOException

Throws:

java.io.IOException

booleanValue

public static boolean booleanValue(java.lang.String string,
                                   boolean deflt)

findSourceFile

public static java.io.File findSourceFile(java.lang.StackTraceElement e)

launchFileEditor

public static java.lang.Process launchFileEditor(java.io.File file,
                                                 int line)
                                          throws java.io.IOException

Throws:

java.io.IOException

escapeXML

public static java.lang.String escapeXML(java.lang.String string)

Replaces angle brackets by html entities.

findImplementationsInJar

public static void findImplementationsInJar(java.util.jar.JarFile jar,
                                            java.lang.Class superClass,
                                            java.util.List<java.lang.String> implementations)

findImplementationsInJar

public static void findImplementationsInJar(java.lang.ClassLoader loader,
                                            java.util.jar.JarFile jar,
                                            java.lang.Class<?> superClass,
                                            java.util.List<java.lang.String> implementations)

classForName

public static java.lang.Class classForName(java.lang.String className)
                                    throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException