Toolkit (Jenkins Serenity plugin 1.4 API)

java.lang.Object
- com.ikokoon.toolkit.Toolkit

```
public final class Toolkit
extends Object
```
This class contains methods for changing a string to the byte code representation and visa versa. Also some other nifty functions like stripping a string of white space etc.

Since:

12.07.09

Version:

01.00

Author:

Michael Couck

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Toolkit.IFileFilter
This is the interface to select files with below.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Toolkit.IFileFilter` This is the interface to select files with below.

Constructor Summary

Constructors
Constructor and Description

Toolkit()

Constructors
Constructor and Description
`Toolkit()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`classNameToPackageName(String className)` Takes the name of a class and returns the package name for the class.
`static String`	`cleanFilePath(String path)`
`static void`	`copyFile(File in, File out)`
`static boolean`	`createFile(File file)`
`static void`	`deleteFile(File file, int maxRetryCount)` Deletes all the files recursively and then the directories recursively.
`static void`	`deleteFiles(File file, String... extensions)` Deletes all the files in a directory with one of the specified extensions.
`static String`	`dotToSlash(String name)` This method replaces the .
`static <E> E`	`executeMethod(Object object, String methodName, Object[] parameters)`
`static void`	`findFiles(File file, Toolkit.IFileFilter filter, List<File> list)` Finds files on the file system below the directory specified recursively using the selection criteria supplied in the IFileFilter parameter.
`static double`	`format(double d, int precision)` Formats a double to the required precision.
`static String`	`format(String string, int precision)` Formats a string to the desired precision.
`static ByteArrayOutputStream`	`getContents(File file)` Reads the contents of the file and returns the contents in a byte array form.
`static ByteArrayOutputStream`	`getContents(InputStream inputStream)` Reads the contents of the file and returns the contents in a byte array form.
`static File`	`getOrCreateDirectory(File file)` Gets a single directory.
`static String`	`getStringContents(InputStream inputStream)`
`static <T> T[]`	`getUniqueValues(T t)` Returns an array of values that are defined as being a unique combination for the entity by using the Unique annotation for the class.
`static <E> E`	`getValue(Class<E> klass, Object object, String name)` Returns the value of the field specified from the object specified.
`static Long`	`hash(Object... objects)` Builds a hash from an array of objects.
`static Long`	`hash(String string)` Simple, fast hash function to generate quite unique hashes from strings(i.e.
`static boolean`	`isDigits(String string)` Verifies that all the characters in a string are digits, ie.
`static String`	`replaceAll(String aInput, String aOldPattern, String aNewPattern)` If Java 1.4 is unavailable, the following technique may be used.
`static void`	`setContents(File file, byte[] bytes)` Writes the contents of a byte array to a file.
`static String`	`slashToDot(String name)` This method replaces the / in the byte code name with .
`static String`	`stripWhitespace(String string)` Removes any whitespace from the string.

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

- Constructor Detail
  - Toolkit
```
public Toolkit()
```
- Method Detail
  - hash
```
public static Long hash(String string)
```
    Simple, fast hash function to generate quite unique hashes from strings(i.e. toCharArray()).
    
    Parameters:
    
    string - the string to generate the hash from
    
    Returns:
    
    the integer representation of the hash of the string characters, typically quite unique for strings less than 10 characters
  - hash
```
public static Long hash(Object... objects)
```
    Builds a hash from an array of objects.
    
    Parameters:
    
    objects - the objects to build the hash from
    
    Returns:
    
    the hash of the objects
  - slashToDot
```
public static String slashToDot(String name)
```
    This method replaces the / in the byte code name with . which is XML friendly.
    
    Parameters:
    
    name - the byte code name of a class
    
    Returns:
    
    the Java name of the class
  - dotToSlash
```
public static String dotToSlash(String name)
```
    This method replaces the . in the byte code name with / which is what we expect from byte code.
    
    Parameters:
    
    name - the name of the class or package
    
    Returns:
    
    the byte code name of the class or package
  - classNameToPackageName
```
public static String classNameToPackageName(String className)
```
    Takes the name of a class and returns the package name for the class.
    
    Parameters:
    
    className - the name of the class fully qualified
    
    Returns:
    
    the package name of the class
  - stripWhitespace
```
public static String stripWhitespace(String string)
```
    Removes any whitespace from the string.
    
    Parameters:
    
    string - the string to remove whitespace from
    
    Returns:
    
    the string without any whitespace that includes carriage returns etc.
  - getValue
```
public static <E> E getValue(Class<E> klass,
                             Object object,
                             String name)
```
    Returns the value of the field specified from the object specified.
    
    Type Parameters:
    
    E - the type to return
    
    Parameters:
    
    klass - the class to get the value for
    
    object - the object to get the field value from
    
    name - the name of the field in the object
    
    Returns:
    
    the value of the field if there is such a field or null if there isn't ir if anything goes wrong
  - executeMethod
```
public static <E> E executeMethod(Object object,
                                  String methodName,
                                  Object[] parameters)
```
  - deleteFile
```
public static void deleteFile(File file,
                              int maxRetryCount)
```
    Deletes all the files recursively and then the directories recursively.
    
    Parameters:
    
    file - the directory or file to delete
    
    maxRetryCount - the number of times to retry to delete the file
  - deleteFiles
```
public static void deleteFiles(File file,
                               String... extensions)
```
    Deletes all the files in a directory with one of the specified extensions.
    
    Parameters:
    
    file - the file to delete or the directory to delete files in
    
    extensions - the extensions of files to delete
  - findFiles
```
public static void findFiles(File file,
                             Toolkit.IFileFilter filter,
                             List<File> list)
```
    Finds files on the file system below the directory specified recursively using the selection criteria supplied in the IFileFilter parameter.
    
    Parameters:
    
    file - the file to start looking from
    
    filter - the filter to select files with
    
    list - the list of files to add the selected files to
  - getContents
```
public static ByteArrayOutputStream getContents(File file)
```
    Reads the contents of the file and returns the contents in a byte array form.
    
    Parameters:
    
    file - the file to read the contents from
    
    Returns:
    
    the file contents in a byte array output stream
  - getContents
```
public static ByteArrayOutputStream getContents(InputStream inputStream)
```
    Reads the contents of the file and returns the contents in a byte array form.
    
    Parameters:
    
    inputStream - the file to read the contents from
    
    Returns:
    
    the file contents in a byte array output stream
  - getStringContents
```
public static String getStringContents(InputStream inputStream)
```
  - setContents
```
public static void setContents(File file,
                               byte[] bytes)
```
    Writes the contents of a byte array to a file.
    
    Parameters:
    
    file - the file to write to
    
    bytes - the byte data to write
  - format
```
public static double format(double d,
                            int precision)
```
    Formats a double to the required precision.
    
    Parameters:
    
    d - the double to format
    
    precision - the precision for the result
    
    Returns:
    
    the double formatted to the required precision
  - format
```
public static String format(String string,
                            int precision)
```
    Formats a string to the desired precision.
    
    Parameters:
    
    string - the string to format to a precision
    
    precision - the precision of the result
    
    Returns:
    
    the string formatted to the required precision
  - getUniqueValues
```
public static <T> T[] getUniqueValues(T t)
```
    Returns an array of values that are defined as being a unique combination for the entity by using the Unique annotation for the class.
    
    Type Parameters:
    
    T - the type of object to be inspected for unique fields
    
    Parameters:
    
    t - the object t inspect for unique field combinations
    
    Returns:
    
    the array of unique field values for the entity
  - copyFile
```
public static void copyFile(File in,
                            File out)
```
  - replaceAll
```
public static String replaceAll(String aInput,
                                String aOldPattern,
                                String aNewPattern)
```
    If Java 1.4 is unavailable, the following technique may be used.
    
    Parameters:
    
    aInput - is the original String which may contain substring aOldPattern
    
    aOldPattern - is the non-empty substring which is to be replaced
    
    aNewPattern - is the replacement for aOldPattern
    
    Returns:
    
    the new string with the replaced characters
  - createFile
```
public static boolean createFile(File file)
```
  - getOrCreateDirectory
```
public static File getOrCreateDirectory(File file)
```
    Gets a single directory. First looking to find it, if it can not be found then it is created.
    
    Parameters:
    
    file - the directory that is requested
    
    Returns:
    
    the found or newly created File or null if something went wrong.
  - isDigits
```
public static boolean isDigits(String string)
```
    Verifies that all the characters in a string are digits, ie. the string is a number.
    
    Parameters:
    
    string - the string to verify for digit data
    
    Returns:
    
    whether every character in a string is a digit
  - cleanFilePath
```
public static String cleanFilePath(String path)
```

Class Toolkit

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Toolkit

Method Detail

hash

hash

slashToDot

dotToSlash

classNameToPackageName

stripWhitespace

getValue

executeMethod

deleteFile

deleteFiles

findFiles

getContents

getContents

getStringContents

setContents

format

format

getUniqueValues

copyFile

replaceAll

createFile

getOrCreateDirectory

isDigits

cleanFilePath