Tools (GateIn - Common component (common) 2.2.3.Final-SNAPSHOT API)

java.lang.Object
- org.gatein.common.util.Tools

```
public class Tools
extends Object
```
Version:

$Revision: 7377 $

Author:

Julien Viet, Thomas Heute, Boleslaw Dawidowicz, Chris Laprun

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BUFFER_SIZE`
`static ResourceBundle`	`EMPTY_BUNDLE`
`static Enumeration`	`EMPTY_ENUMERATION`
`static Iterator`	`EMPTY_ITERATOR`
`static Logger`	`log`
`static String`	`VMID` 16 chars long VMID.

Constructor Summary

Constructors
Constructor and Description

Tools()

Constructors
Constructor and Description
`Tools()`

Method Summary

Methods
Modifier and Type	Method and Description
`static <E> E[]`	`appendTo(E[] array, E o)` Append an object to an array of objects.
`static String`	`buildClassLoaderInfo(ClassLoader loader)`
`static int`	`computeStringHash(int hash, String s)`
`static boolean`	`confirmTemporaryHash(String hash, String value, long time)`
`static String`	`dumpClassLoaderHierarchyInfo(ClassLoader loader)`
`static void`	`dumpClassLoaderHierarchyInfo(Writer writer, ClassLoader loader)`
`static <E> Enumeration<E>`	`emptyEnumeration()`
`static <E> Iterator<E>`	`emptyIterator()`
`static <T> MultiValuedPropertyMap<T>`	`emptyMultiValuedPropertyMap()`
`static byte[]`	`fromHexString(String hex)` Returns a byte array converted from the hexadecimal format.
`static String`	`generateTemporaryHash(String value, long time)`
`static String`	`getPackageOf(Class clazz)`
`static String`	`getShortNameOf(Class clazz)`
`static String`	`hashAndEncodeString(String text, String algorithm, String encoding)` Computes a hash with specified algorighm and returns the result as a string in hexadecimal format
`static boolean`	`isContainedIn(Object value, Object[] array)` Determines if value is contained in array.
`static <E> Iterator<E>`	`iterator(E... objects)` Returns an iterator over the array elements.
`static <E> Iterator<E>`	`iterator(E o)` Returns a singleton iterator.
`static <E> Iterator<E>`	`iterator(E[] objects, int from, int to)` Returns an iterator over the array elements within the specified range.
`static byte[]`	`md5(String text)` Computes an md5 hash of a string.
`static String`	`md5AsHexString(String text)` Computes an md5 hash and returns the result as a string in hexadecimal format.
`static <T> T`	`safeCast(Object value, Class<T> type)` Attempt to cast the value argument to the provided type argument.
`static boolean`	`safeEquals(Object o1, Object o2)` Return true if o1 is null and o2 is null o1 is not null and the invocation of `equals(Object o)` on o1 wit o2 as argument returns true
`static Object[]`	`toArray(Iterator i)` Deprecated.
`static <E> Enumeration<E>`	`toEnumeration(E o)`
`static <E> Enumeration<E>`	`toEnumeration(E[] objects)`
`static <E> Enumeration<E>`	`toEnumeration(Iterator<E> iterator)`
`static String`	`toHexString(byte[] bytes)` Returns a string in the hexadecimal format.
`static <E> List<E>`	`toList(E... objects)`
`static <E> List<E>`	`toList(Enumeration<E> e)`
`static <E> List<E>`	`toList(Iterator<E> iterator)`
`static <E> Set<E>`	`toSet(E... objects)`
`static <E> Set<E>`	`toSet(Enumeration<E> e)`
`static <E> Set<E>`	`toSet(Iterator<E> iterator)` Transforms an iterator into an unordered Set
`static <E> Set<E>`	`toSet(Iterator<E> iterator, boolean preserveOrder)` Transforms an iterator into a Set

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

- Field Detail
  - DEFAULT_BUFFER_SIZE
```
public static final int DEFAULT_BUFFER_SIZE
```
    See Also:
    Constant Field Values
  - log
```
public static final Logger log
```
  - VMID
```
public static final String VMID
```
    16 chars long VMID.
  - EMPTY_ENUMERATION
```
public static final Enumeration EMPTY_ENUMERATION
```
  - EMPTY_ITERATOR
```
public static final Iterator EMPTY_ITERATOR
```
  - EMPTY_BUNDLE
```
public static final ResourceBundle EMPTY_BUNDLE
```
- Constructor Detail
  - Tools
```
public Tools()
```
- Method Detail
  - emptyEnumeration
```
public static <E> Enumeration<E> emptyEnumeration()
```
  - emptyIterator
```
public static <E> Iterator<E> emptyIterator()
```
  - toEnumeration
```
public static <E> Enumeration<E> toEnumeration(Iterator<E> iterator)
```
  - toEnumeration
```
public static <E> Enumeration<E> toEnumeration(E[] objects)
```
  - toEnumeration
```
public static <E> Enumeration<E> toEnumeration(E o)
```
  - toSet
```
public static <E> Set<E> toSet(Enumeration<E> e)
```
  - toSet
```
public static <E> Set<E> toSet(E... objects)
```
  - toSet
```
public static <E> Set<E> toSet(Iterator<E> iterator)
```
    Transforms an iterator into an unordered Set
    
    Parameters:
    iterator - The iterator to transform
    
    Returns:
    A HashSet
  - toSet
```
public static <E> Set<E> toSet(Iterator<E> iterator,
               boolean preserveOrder)
```
    Transforms an iterator into a Set
    
    Parameters:
    iterator - The iterator to transform
    preserveOrder - true if the set must respect the ordering of the iterator
    
    Returns:
    a LinkedHashSet if ordered is true, a HashSet otherwise
  - toList
```
public static <E> List<E> toList(Enumeration<E> e)
```
  - toList
```
public static <E> List<E> toList(Iterator<E> iterator)
```
  - toList
```
public static <E> List<E> toList(E... objects)
```
  - toArray
```
@Deprecated
public static Object[] toArray(Iterator i)
```
    Deprecated.
    
    Consider remove this method as it cannot be generified.
    
    Parameters:
    i -
    
    Returns:
  - iterator
```
public static <E> Iterator<E> iterator(E o)
```
    Returns a singleton iterator.
    
    Parameters:
    o - the singleton object
    
    Returns:
    the iterator
  - iterator
```
public static <E> Iterator<E> iterator(E... objects)
                            throws IllegalArgumentException
```
    Returns an iterator over the array elements.
    
    Parameters:
    objects - the array containing the objects to iterate on
    
    Returns:
    the iterator
    
    Throws:
    
    IllegalArgumentException - if the object array is null or the specified range is not valid
  - iterator
```
public static <E> Iterator<E> iterator(E[] objects,
                       int from,
                       int to)
                            throws IllegalArgumentException
```
    Returns an iterator over the array elements within the specified range. The range is considered as valid if the from argument is greater or equals than zero, the to argument is lesser or equals than array size and the from argument is lesser or equals to the to argument.
    
    Parameters:
    objects - the array containing the objects to iterate on
    from - the inclusive start index
    to - the exclusive stop index
    
    Returns:
    the iterator
    
    Throws:
    
    IllegalArgumentException - if the object array is null or the specified range is not valid or if the range is not valid
  - computeStringHash
```
public static int computeStringHash(int hash,
                    String s)
```
  - md5
```
public static byte[] md5(String text)
```
    Computes an md5 hash of a string.
    
    Parameters:
    text - the hashed string
    
    Returns:
    the string hash
    
    Throws:
    
    NullPointerException - if text is null
  - md5AsHexString
```
public static String md5AsHexString(String text)
```
    Computes an md5 hash and returns the result as a string in hexadecimal format.
    
    Parameters:
    text - the hashed string
    
    Returns:
    the string hash
    
    Throws:
    
    NullPointerException - if text is null
  - hashAndEncodeString
```
public static String hashAndEncodeString(String text,
                         String algorithm,
                         String encoding)
                                  throws NoSuchAlgorithmException
```
    Computes a hash with specified algorighm and returns the result as a string in hexadecimal format
    
    Parameters:
    text -
    algorithm -
    encoding -
    
    Returns:
    
    Throws:
    
    NoSuchAlgorithmException
  - toHexString
```
public static String toHexString(byte[] bytes)
```
    Returns a string in the hexadecimal format.
    
    Parameters:
    bytes - the converted bytes
    
    Returns:
    the hexadecimal string representing the bytes data
    
    Throws:
    
    IllegalArgumentException - if the byte array is null
  - fromHexString
```
public static byte[] fromHexString(String hex)
```
    Returns a byte array converted from the hexadecimal format.
    
    Parameters:
    hex - the string to convert
    
    Returns:
    the byte array corresponding
    
    Throws:
    
    IllegalArgumentException - if the string is null or does not have the good format
  - generateTemporaryHash
```
public static String generateTemporaryHash(String value,
                           long time)
```
  - confirmTemporaryHash
```
public static boolean confirmTemporaryHash(String hash,
                           String value,
                           long time)
```
  - getShortNameOf
```
public static String getShortNameOf(Class clazz)
```
  - getPackageOf
```
public static String getPackageOf(Class clazz)
```
  - buildClassLoaderInfo
```
public static String buildClassLoaderInfo(ClassLoader loader)
```
  - dumpClassLoaderHierarchyInfo
```
public static String dumpClassLoaderHierarchyInfo(ClassLoader loader)
```
  - dumpClassLoaderHierarchyInfo
```
public static void dumpClassLoaderHierarchyInfo(Writer writer,
                                ClassLoader loader)
```
  - appendTo
```
public static <E> E[] appendTo(E[] array,
               E o)
                    throws IllegalArgumentException,
                           ClassCastException
```
    Append an object to an array of objects. The original array is not modified. The returned array will be of the same component type of the provided array and its first n elements where n is the size of the provided array will be the elements of the provided array. The last element of the array will be the provided object to append.
    
    Parameters:
    array - the array to augment
    o - the object to append
    
    Returns:
    a new array
    
    Throws:
    
    IllegalArgumentException - if the array is null
    
    ClassCastException - if the appended object class prevents it from being added to the array
  - safeEquals
```
public static boolean safeEquals(Object o1,
                 Object o2)
```
    Return true if
    - o1 is null and o2 is null
    - o1 is not null and the invocation of equals(Object o) on o1 wit o2 as argument returns true
    Parameters:
    o1 - the first argument
    o2 - the second argument
    
    Returns:
    if arguments are equals according to the semantic defined by the method contract
  - isContainedIn
```
public static boolean isContainedIn(Object value,
                    Object[] array)
```
    Determines if value is contained in array.
    todo: correct this method contract in order to make it more reusable, it looks like for now like a method which has a contract convenient only for some kind of callers.
    1. null value should be accepted (or the method should be called isContainedInButNotForNullValue ?)
    2. null array should not be accepted (or the method should be called isContainedInExceptIfThePassedArrayIsNull ?)
    Parameters:
    value -
    array -
    
    Returns:
    Since:
    
    2.4.2
  - safeCast
```
public static <T> T safeCast(Object value,
             Class<T> type)
```
    Attempt to cast the value argument to the provided type argument. If the value argument type is assignable to the provided type, the value is returned, otherwise if it is not or the value is null, null is returned.
    todo: Move that to common package.
    
    Parameters:
    value - the value to cast
    type - the type to downcast
    
    Returns:
    the casted value or null
  - emptyMultiValuedPropertyMap
```
public static <T> MultiValuedPropertyMap<T> emptyMultiValuedPropertyMap()
```

Class Tools

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BUFFER_SIZE

log

VMID

EMPTY_ENUMERATION

EMPTY_ITERATOR

EMPTY_BUNDLE

Constructor Detail

Tools

Method Detail

emptyEnumeration

emptyIterator

toEnumeration

toEnumeration

toEnumeration

toSet

toSet

toSet

toSet

toList

toList

toList

toArray

iterator

iterator

iterator

computeStringHash

md5

md5AsHexString

hashAndEncodeString

toHexString

fromHexString

generateTemporaryHash

confirmTemporaryHash

getShortNameOf

getPackageOf

buildClassLoaderInfo

dumpClassLoaderHierarchyInfo

dumpClassLoaderHierarchyInfo

appendTo

safeEquals

isContainedIn

safeCast

emptyMultiValuedPropertyMap