org.apache.oodt.commons.util

Class Utility

java.lang.Object

org.apache.oodt.commons.util.Utility

public class Utility
extends Object

Miscellaneous utilities. This class contains various miscellaneous functions as static methods.

Author:

Kelly

Constructor Summary

Constructors

Constructor and Description
Utility()

Method Summary

Modifier and Type	Method and Description
static boolean	delete(File file) Delete a file or directory.
static String	escapeSingleQuote(String inputString) This method will escape any single quotes found in the input string and return the escaped string.
static boolean	isNumeric(String s) Check string s is numeric.
static void	loadProperties(Properties props, Class clazz, String resourceName) Load properties from a resource.
static void	logMemoryStats(String msg) Log statistics on memory to stderr.
static Iterator	parseCommaList(String list) Parse a list.
static void	redirect(InputStream in, OutputStream out) Asynchronously redirect an input stream onto an output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

Utility

public Utility()

Method Detail

loadProperties

public static void loadProperties(Properties props,
                                  Class clazz,
                                  String resourceName)

Load properties from a resource. This loads properties from the given resource (relative to the given class) into the given properties object. If any error occurs, this method prints a message to stderr but otherwise takes no special action.

You typically use this to merge properties for your application into the System properties by calling this method as follows:

Utility.loadProperties(System.getProperties(), MyClass.class,
 "MyClass.properties");

This adds the properties from the file MyClass.properties (which must exist in the same directory as the file MyClass.class, whether in the filesystem or in a jar) into the system properties. You can then fetch these properties from anywhere in your program with System.getProperty(String), Integer.getInteger, etc.

You can also use the method to load properties into a newly created properties object that you provide. This keeps your properties separate, but then you have to pass a properties object all over the place, and you can't take advantage of non-String properties through methods like Long#getLong(String), etc.

Parameters:

props - The properties object to load.

clazz - The class used to locate the resource.

resourceName - The name of the resource.

parseCommaList

public static Iterator parseCommaList(String list)

Parse a list. This yields an iterator created from a list where commas (and optional leading and trailing whitespace) separate each element. Each element will occur only once in the iterator regardless of how many times it appeared in the string.

Parameters:

list - The list to parse.

Returns:

The iterator over unique elements in the list.

redirect

public static void redirect(InputStream in,
                            OutputStream out)

Asynchronously redirect an input stream onto an output stream. The output stream is never closed.

Parameters:

in - Input stream to redirect.

out - Where to redirect in.

logMemoryStats

public static void logMemoryStats(String msg)

Log statistics on memory to stderr.

Parameters:

msg - Text to include in log.

isNumeric

public static boolean isNumeric(String s)

Check string s is numeric. Numeric strings include 5.7, -3.9, 14.981E16, etc.

Parameters:

s - Text to be checked.

Returns:

True is s is a numeric string.

delete

public static boolean delete(File file)

Delete a file or directory. If file references a directory, it recursively deletes all the directory tree.

Parameters:

file - File, directory, or other filesystem artifact to delete.

Returns:

True if file was deleted, false otherwise.

escapeSingleQuote

public static String escapeSingleQuote(String inputString)

This method will escape any single quotes found in the input string and return the escaped string. This will ready the string for insertion into a database. The single quote is escaped by inserting an additional single quote in front of it in the string. If some considerate developer has already escaped the single quotes in the input string, this method will essentially do nothing.

Parameters:

inputString - The string to be escaped.

Returns:

The escaped string.