SUtil (Jadex Active Component Platform 2.0 API.)

java.lang.Object
- jadex.commons.SUtil

```
public class SUtil
extends Object
```
This class provides several useful static util methods.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SUtil.AccessiblePrintStream
An subclass of print stream to allow accessing the underlying stream.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SUtil.AccessiblePrintStream` An subclass of print stream to allow accessing the underlying stream.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONVERT_ALL` Constant that indicates a conversion of all known characters.
`static int`	`CONVERT_ALL_EXCEPT_AMP` Constant that indicates a conversion of all known characters except &.
`static int`	`CONVERT_NONE` Constant that indicates a conversion of no characters.
`static Class[]`	`EMPTY_CLASS_ARRAY` An empty class array.
`static Enumeration`	`EMPTY_ENUMERATION` An empty enumeration.
`static String[]`	`EMPTY_STRING_ARRAY` An empty string array.
`static String`	`NULL` A Null value.
`static int`	`SORT_DOWN` Constant for sorting down.
`static int`	`SORT_UP` Constant for sorting up.

Constructor Summary

Constructors
Constructor and Description

SUtil()

Constructors
Constructor and Description
`SUtil()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addSystemErrListener(IChangeListener listener)` Add a listener to System.err.
`static void`	`addSystemOutListener(IChangeListener listener)` Add a listener to System.out.
`static boolean`	`arrayContains(Object array, Object value)` Check if an element is contained in an array.
`static boolean`	`arrayEquals(Object array1, Object array2)` Test if two arrays are content equal or both null.
`static int`	`arrayHashCode(Object a)` Calculate a hash code for an array.
`static <T> List<T>`	`arrayToList(Object a)` Transform an array to a vector.
`static Set`	`arrayToSet(Object a)` Transform an array to a vector.
`static String`	`arrayToString(Object array)` Get a string representation for an array.
`static int`	`bytesToInt(byte[] buffer)` Convert bytes to an integer.
`static List`	`calculateCartesianProduct(String[] names, Object[] values)` Calculate the cartesian product of parameters.
`static int`	`compareTo(String a, String b)` Compares two strings, ignoring case.
`static String`	`convertPathToPackage(String path, ClassLoader classloader)` Find a package name from a path.
`static String`	`convertPathToRelative(String absolute)` Convert an absolute path to a relative path based on the current user directory.
`static String`	`convertURLToString(URL url)` Convert an URL to a local file name.
`static List`	`createArrayList(Object[] values)` Create an array list from values.
`static Map`	`createHashMap(Object[] keys, Object[] values)` Create a hash map from keys and values.
`static Set`	`createHashSet(Object[] values)` Create a hash set from values.
`static String`	`createUniqueId(String name)` Create a globally unique conversation id.
`static String`	`createUniqueId(String name, int length)` Create a globally unique conversation id.
`static Object`	`cutArrays(Object a1, Object a2)` Cut two arrays.
`static boolean`	`equals(Object val1, Object val2)`
`static int`	`getArrayDimension(Object array)` Get the array dimension.
`static List`	`getClasspathURLs(ClassLoader classloader)` Get the current classpath as a list of URLs
`static String`	`getDurationHMS(long ms)` Get a string representation for a duration.
`static InetAddress`	`getInet4Address()` Get a IPV4 address of the local host.
`static short`	`getNetworkPrefixLength(InetAddress iadr)` Get the network prefix length for IPV4 address 24=C, 16=B, 8=A classes.
`static String`	`getPlural(String s)` Get the plural of a word in singular.
`static InputStream`	`getResource(String name, ClassLoader classloader)` Get an input stream for whatever provided. 1.
`static InputStream`	`getResource0(String name, ClassLoader classloader)` Get an input stream for whatever provided. 1.
`static ResourceInfo`	`getResourceInfo0(String name, ClassLoader classloader)` Get an input stream for whatever provided. 1.
`static String`	`getSingular(String s)` Get the singular of a word in plural.
`static String[]`	`getStringArray(String key, Properties props)` Get a string array of properties that are separated by commas.
`static byte[]`	`intToBytes(int val)` Convert an integer to bytes.
`static boolean`	`isInRange(Date date, Date start, Date end)` Test if the date is in the range.
`static boolean`	`isJavaSourceFilename(String filename)` Test if a file is a Java source file.
`static Object[]`	`iteratorToArray(Iterator it, Class clazz)` Transform an iterator to an array.
`static List`	`iteratorToList(Iterator it)` Transform an iterator to a list.
`static List`	`iteratorToList(Iterator it, List ret)` Transform an iterator to a list.
`static Object[]`	`joinArbitraryArrays(Object[] as)` Joins any arrays of (possibly) different type. todo: Does not support basic types yet.
`static Object`	`joinArrays(Object a1, Object a2)` Joins two arrays of the same type.
`static void`	`main(String[] args)` Main method for testing.
`static String`	`makeConform(String input)` Convert an output to html/wml conform presentation.
`static String`	`makeConform(String input, int flag)` Convert an output to html/wml conform presentation.
`static String`	`makeEnglishConform(String input)` Convert an output readable in english.
`static String`	`removeExtension(String fn)` Remove file extension.
`static void`	`removeSystemErrListener(IChangeListener listener)` Remove a listener from System.err.
`static void`	`removeSystemOutListener(IChangeListener listener)` Remove a listener from System.out.
`static void`	`replace(String source, StringBuffer dest, String old, String newstring)` Parse a source string replacing occurrences and storing the result in the given string buffer.
`static String`	`replace(String source, String old, String newstring)` Parse a source string replacing occurrences and returning the result.
`static String`	`stripTags(String source)` Strip tags (e.g. html) from a string, leaving only the text content.
`static Object`	`substractArrays(Object a1, Object a2)` First array minus second array.
`static String`	`wrapText(String text)` Wrap a text at a given line length.
`static String`	`wrapText(String text, int wrap)` Wrap a text at a given line length.

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

- Field Detail
  - CONVERT_ALL
```
public static final int CONVERT_ALL
```
    Constant that indicates a conversion of all known characters.
    
    See Also:
    Constant Field Values
  - CONVERT_ALL_EXCEPT_AMP
```
public static final int CONVERT_ALL_EXCEPT_AMP
```
    Constant that indicates a conversion of all known characters except &.
    
    See Also:
    Constant Field Values
  - CONVERT_NONE
```
public static final int CONVERT_NONE
```
    Constant that indicates a conversion of no characters.
    
    See Also:
    Constant Field Values
  - NULL
```
public static final String NULL
```
    A Null value.
    
    See Also:
    Constant Field Values
  - EMPTY_ENUMERATION
```
public static final Enumeration EMPTY_ENUMERATION
```
    An empty enumeration.
  - EMPTY_STRING_ARRAY
```
public static final String[] EMPTY_STRING_ARRAY
```
    An empty string array.
  - EMPTY_CLASS_ARRAY
```
public static final Class[] EMPTY_CLASS_ARRAY
```
    An empty class array.
  - SORT_UP
```
public static final int SORT_UP
```
    Constant for sorting up.
    
    See Also:
    Constant Field Values
  - SORT_DOWN
```
public static final int SORT_DOWN
```
    Constant for sorting down.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - SUtil
```
public SUtil()
```
- Method Detail
  - getStringArray
```
public static String[] getStringArray(String key,
                      Properties props)
```
    Get a string array of properties that are separated by commas.
    
    Parameters:
    key - The key.
    props - The properties.
    
    Returns:
    The strings.
  - joinArrays
```
public static Object joinArrays(Object a1,
                Object a2)
```
    Joins two arrays of the same type. Creates a new array containing the values of the first array followed by the values of the second.
    
    Parameters:
    a1 - The first array.
    a2 - The second array.
    
    Returns:
    The joined array.
  - joinArbitraryArrays
```
public static Object[] joinArbitraryArrays(Object[] as)
```
    Joins any arrays of (possibly) different type. todo: Does not support basic types yet. Problem basic type array and object arrays cannot be mapped (except they are mapped).
    
    Parameters:
    as - The array of arrays to join..
    
    Returns:
    The joined array.
  - cutArrays
```
public static Object cutArrays(Object a1,
               Object a2)
```
    Cut two arrays.
    
    Parameters:
    a1 - The first array.
    a2 - The second array.
    
    Returns:
    The cutted array.
  - substractArrays
```
public static Object substractArrays(Object a1,
                     Object a2)
```
    First array minus second array.
    
    Parameters:
    a1 - The first array.
    a2 - The second array.
    
    Returns:
    The substracted array.
  - arrayToList
```
public static <T> List<T> arrayToList(Object a)
```
    Transform an array to a vector.
    
    Parameters:
    a - The array.
    
    Returns:
    The vector for the array.
  - arrayToSet
```
public static Set arrayToSet(Object a)
```
    Transform an array to a vector.
    
    Parameters:
    a - The array.
    
    Returns:
    The vector for the array.
  - iteratorToList
```
public static List iteratorToList(Iterator it)
```
    Transform an iterator to a list.
  - iteratorToList
```
public static List iteratorToList(Iterator it,
                  List ret)
```
    Transform an iterator to a list.
  - iteratorToArray
```
public static Object[] iteratorToArray(Iterator it,
                       Class clazz)
```
    Transform an iterator to an array.
  - arrayContains
```
public static boolean arrayContains(Object array,
                    Object value)
```
    Check if an element is contained in an array.
    
    Parameters:
    array - The array.
    value - The value.
  - getArrayDimension
```
public static int getArrayDimension(Object array)
```
    Get the array dimension.
    
    Parameters:
    array - The array.
    
    Returns:
    The number of dimensions.
  - equals
```
public static boolean equals(Object val1,
             Object val2)
```
  - arrayEquals
```
public static boolean arrayEquals(Object array1,
                  Object array2)
```
    Test if two arrays are content equal or both null.
    
    Parameters:
    array1 - The first array.
    array2 - The second array.
    
    Returns:
    True when the arrays are content equal.
  - arrayHashCode
```
public static int arrayHashCode(Object a)
```
    Calculate a hash code for an array.
  - arrayToString
```
public static String arrayToString(Object array)
```
    Get a string representation for an array.
    
    Parameters:
    array - The array.
    
    Returns:
    formatted string.
  - getSingular
```
public static String getSingular(String s)
```
    Get the singular of a word in plural. Does NOT find all correct singular.
    
    Parameters:
    s - The plural word.
    
    Returns:
    The singular of this word.
  - getPlural
```
public static String getPlural(String s)
```
    Get the plural of a word in singular. Does NOT find all correct plurals.
    
    Parameters:
    s - The word.
    
    Returns:
    The plural of this word.
  - compareTo
```
public static int compareTo(String a,
            String b)
```
    Compares two strings, ignoring case.
    
    Parameters:
    a - The first string.
    b - The second string.
    
    Returns:
    a <0
  isInRange
  
  public static boolean isInRange(Date date, Date start, Date end)
  
  Test if the date is in the range. Start or end may null and will so not be checked.
  
  Parameters:
  date - The date.
  start - The start.
  end - The end.
  
  Returns:
  True, if date is in range.
  
  removeExtension
  
  public static String removeExtension(String fn)
  
  Remove file extension.
  
  Parameters:
  fn - The filename..
  
  Returns:
  filename without extension.
  
  wrapText
  
  public static String wrapText(String text)
  
  Wrap a text at a given line length. Doesn't to word wrap, just inserts linebreaks every nth character. If the string already contains linebreaks, these are handled properly (extra linebreaks will only be inserted when needed).
  
  Parameters:
  text - The text to wrap.
  
  wrapText
  
  public static String wrapText(String text, int wrap)
  
  Wrap a text at a given line length. Doesn't to word wrap, just inserts linebreaks every nth character. If the string already contains linebreaks, these are handled properly (extra linebreaks will only be inserted when needed).
  
  Parameters:
  text - The text to wrap.
  wrap - The column width.
  
  makeConform
  
  public static String makeConform(String input)
  
  Convert an output to html/wml conform presentation.
  
  Parameters:
  input - The input string.
  
  Returns:
  The converted output string.
  
  makeConform
  
  public static String makeConform(String input, int flag)
  
  Convert an output to html/wml conform presentation.
  
  Parameters:
  input - The input string.
  flag - CONVERT_ALL, CONVERT_NONE, CONVERT_ALL_EXCEPT_AMP;
  
  Returns:
  The converted output string.
  
  stripTags
  
  public static String stripTags(String source)
  
  Strip tags (e.g. html) from a string, leaving only the text content.
  
  makeEnglishConform
  
  public static String makeEnglishConform(String input)
  
  Convert an output readable in english. Therefore remove all äs, ös, üs etc.
  
  Parameters:
  input - The input string.
  
  Returns:
  The converted output string.
  
  replace
  
  public static void replace(String source, StringBuffer dest, String old, String newstring)
  
  Parse a source string replacing occurrences and storing the result in the given string buffer. This is a fast alternative to String.replaceAll(), because it does not use regular expressions.
  
  Parameters:
  source - The source string.
  dest - The destination string buffer.
  old - The string to replace.
  newstring - The string to use as replacement.
  
  replace
  
  public static String replace(String source, String old, String newstring)
  
  Parse a source string replacing occurrences and returning the result. This is a fast alternative to String.replaceAll(), because it does not use regular expressions.
  
  Parameters:
  source - The source string.
  old - The string to replace.
  newstring - The string to use as replacement.
  
  getResource
  
  public static InputStream getResource(String name, ClassLoader classloader) throws IOException
  
  Get an input stream for whatever provided. 1. It is tried to load the resource as file. 2. It is tried to load the resource via the ClassLoader. 3. It is tried to load the resource as URL.
  
  Parameters:
  name - The resource description.
  
  Returns:
  The input stream for the resource.
  
  Throws:
  
  IOException - when the resource was not found.
  
  getResource0
  
  public static InputStream getResource0(String name, ClassLoader classloader)
  
  Get an input stream for whatever provided. 1. It is tried to load the resource as file. 2. It is tried to load the resource via the ClassLoader. 3. It is tried to load the resource as URL.
  
  Parameters:
  name - The resource description.
  
  Returns:
  The input stream for the resource or null when the resource was not found.
  
  getResourceInfo0
  
  public static ResourceInfo getResourceInfo0(String name, ClassLoader classloader)
  
  Get an input stream for whatever provided. 1. It is tried to load the resource as file. 2. It is tried to load the resource via the ClassLoader. 3. It is tried to load the resource as URL.
  
  Parameters:
  name - The resource description.
  
  Returns:
  The info object for the resource or null when the resource was not found.
  
  getDurationHMS
  
  public static String getDurationHMS(long ms)
  
  Get a string representation for a duration.
  
  Parameters:
  ms - The duration in ms.
  
  Returns:
  The string representation.
  
  convertPathToPackage
  
  public static String convertPathToPackage(String path, ClassLoader classloader)
  
  Find a package name from a path. Searches the most specific classpath and uses the rest of the pathname as package name.
  
  Parameters:
  path - The directory.
  
  Returns:
  The package.
  
  getClasspathURLs
  
  public static List getClasspathURLs(ClassLoader classloader)
  
  Get the current classpath as a list of URLs
  
  calculateCartesianProduct
  
  public static List calculateCartesianProduct(String[] names, Object[] values)
  
  Calculate the cartesian product of parameters. Example: names = {"a", "b"}, values = {{"1", "2"}, {"3", "4"}} result = {{"a"="1", "b"="3"}, {"a"="2", "b"="3"}, {"a"="1", "b"="4"}, {"a=2", b="4"}}
  
  Parameters:
  names - The names.
  values - The values (must be some form of collection, i.e. array, list, iterator etc.)
  
  isJavaSourceFilename
  
  public static boolean isJavaSourceFilename(String filename)
  
  Test if a file is a Java source file.
  
  Parameters:
  filename - The filename.
  
  Returns:
  True, if it is a Java source file.
  
  createHashMap
  
  public static Map createHashMap(Object[] keys, Object[] values)
  
  Create a hash map from keys and values.
  
  Parameters:
  keys - The keys.
  values - The values.
  
  Returns:
  The map.
  
  createHashSet
  
  public static Set createHashSet(Object[] values)
  
  Create a hash set from values.
  
  Parameters:
  values - The values.
  
  Returns:
  The map.
  
  createArrayList
  
  public static List createArrayList(Object[] values)
  
  Create an array list from values.
  
  Parameters:
  values - The values.
  
  Returns:
  The map.
  
  createUniqueId
  
  public static String createUniqueId(String name)
  
  Create a globally unique conversation id.
  
  Returns:
  The conversation id.
  
  createUniqueId
  
  public static String createUniqueId(String name, int length)
  
  Create a globally unique conversation id.
  
  Returns:
  The conversation id.
  
  main
  
  public static void main(String[] args)
  
  Main method for testing.
  
  convertPathToRelative
  
  public static String convertPathToRelative(String absolute)
  
  Convert an absolute path to a relative path based on the current user directory.
  
  bytesToInt
  
  public static int bytesToInt(byte[] buffer)
  
  Convert bytes to an integer.
  
  intToBytes
  
  public static byte[] intToBytes(int val)
  
  Convert an integer to bytes.
  
  convertURLToString
  
  public static String convertURLToString(URL url)
  
  Convert an URL to a local file name.
  
  Parameters:
  url - The url.
  
  Returns:
  The absolute path to the url resource.
  
  addSystemOutListener
  
  public static void addSystemOutListener(IChangeListener listener)
  
  Add a listener to System.out.
  
  removeSystemOutListener
  
  public static void removeSystemOutListener(IChangeListener listener)
  
  Remove a listener from System.out.
  
  addSystemErrListener
  
  public static void addSystemErrListener(IChangeListener listener)
  
  Add a listener to System.err.
  
  removeSystemErrListener
  
  public static void removeSystemErrListener(IChangeListener listener)
  
  Remove a listener from System.err.
  
  getInet4Address
  
  public static InetAddress getInet4Address()
  
  Get a IPV4 address of the local host. Ignores loopback address and V6 addresses.
  
  Returns:
  First found IPV4 address.
  
  getNetworkPrefixLength
  
  public static short getNetworkPrefixLength(InetAddress iadr)
  
  Get the network prefix length for IPV4 address 24=C, 16=B, 8=A classes. Returns -1 in case of V6 address.
  
  Parameters:
  iadr - The address.
  
  Returns:
  The length of the prefix.

Class SUtil

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONVERT_ALL

CONVERT_ALL_EXCEPT_AMP

CONVERT_NONE

NULL

EMPTY_ENUMERATION

EMPTY_STRING_ARRAY

EMPTY_CLASS_ARRAY

SORT_UP

SORT_DOWN

Constructor Detail

SUtil

Method Detail

getStringArray

joinArrays

joinArbitraryArrays

cutArrays

substractArrays

arrayToList

arrayToSet

iteratorToList

iteratorToList

iteratorToArray

arrayContains

getArrayDimension

equals

arrayEquals

arrayHashCode

arrayToString

getSingular

getPlural

compareTo

isInRange

removeExtension

wrapText

wrapText

makeConform

makeConform

stripTags

makeEnglishConform

replace

replace

getResource

getResource0

getResourceInfo0

getDurationHMS

convertPathToPackage

getClasspathURLs

calculateCartesianProduct

isJavaSourceFilename

createHashMap

createHashSet

createArrayList

createUniqueId

createUniqueId

main

convertPathToRelative

bytesToInt

intToBytes

convertURLToString

addSystemOutListener

removeSystemOutListener

addSystemErrListener

removeSystemErrListener

getInet4Address

getNetworkPrefixLength