CASAUtil

java.lang.Object
- casa.util.CASAUtil

```
public class CASAUtil
extends Object
```
Meant to be a place to store useful utility functions for CASA
Copyright: Copyright 2003-2014, Knowledge Science Group, University of Calgary. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. The Knowledge Science Group makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Version:

0.9

Author:

Rob Kremer

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static TreeMap<String,InetAddress[]>`	`cachedAddresses`
`private static InetAddress`	`cachedLocalHost`
`private static String`	`ESCAPED_CHARACTERS`
`private static String[]`	`myAddresses` Used to cache the return value from `getMyAddresses()`.
`private static String[]`	`myHostNames`
`private static InetAddress[]`	`myInetAddresses` Used to cache the return value from `getMyInetAddresses()`.

Constructor Summary

Constructors
Constructor and Description

CASAUtil()

Constructors
Constructor and Description
`CASAUtil()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`byteArrayAsHexString(byte[] buffer)`
`static String`	`bytesToString(byte[] bb, String encoding)`
`static Object`	`callMethod(Class<?> cls, String methodName, Object target, Class<?>[] paramTypes, Object[] params)` Calls a method by name alone, without requiring the compiler to know about it.
`static String`	`decode(String input, boolean decodeAmp)` Given a string with encoded "binary" data ("%hh" for ASCII codes less than 32), returns a string with each of the encoded characters replaced by the approriate "binary" (non-printable) character.
`static String`	`encode(String input, boolean escapeAmp)` Given a string with "binary" data (ASCII codes less than 32), returns a string with each of the non-printable characters (less than ASCII 32) substituted with "%hh", where "h" is a hex digit.
`static String`	`escape(String in, String escChars2)` Returns a new String that is in encoded with backslashes in front of every instance of any character that occurs in escChars.
`static Map<String,Class<?>>`	`fillSubclasses(Map<String,Class<?>> map, Class<?> superclass, String target, String suffix)` Search for a class named target+suffix that is a subclass of superclass.
`static Ontology`	`findOntology(TransientAgent agent, ParamsMap params, AgentUI ui, Environment env)`
`static List<Class<?>>`	`findSubclassesOf(Class<?> superclass)` Returns a list of all the proper subclasses of the parameter class.
`static List<Class<?>>`	`findSubClassesOf(String pckgname, Class<?> superclass)` Returns a list of all the proper subclasses of the parameter class with the parameter package.
`static String`	`formatWidth(String text, int lineWidth, String autoIndent)`
`static String`	`fromQuotedString(String s)` Returns exactly the same results as `fromQuotedString(s,0)`.
`static String`	`fromQuotedString(String s, int startAt)` Given a String (as generated from `toQuotedString(String)`) returns a String without the enclosing quotes and with an escaped double-quotes restored (unescaped).
`static AbstractProcess`	`getAbstractProcessInScope()` Attempt to find an in-scope agent.
`static AbstractProcess`	`getAbstractProcessInScopeSilent()` Attempt to find an in-scope agent.
`static String[]`	`getAddressesFor(InetAddress addr)`
`static String`	`getDateAsString()` Returns the current time as a formated date string in the default format
`static String`	`getDateAsString(Long timeSpec)` Converts the long millisecond time to a formated date string in the default format
`static String`	`getDateAsString(Long timeSpec, String format)` Converts the long millisecond time to a formated date string
`static String`	`getDateAsString(String format)` Returns the current time as a formated date string
`static InetAddress[]`	`getInetAddressesFor(InetAddress addr)`
`private static InetAddress[]`	`getInetAddressesForPrimitive(InetAddress addr)`
`static InetAddress`	`getLocalHost()` This method should be used by CASA in place of `InetAddress.getLocalHost()`.
`static String[]`	`getMyAddresses()`
`static String[]`	`getMyHostNames()`
`static InetAddress[]`	`getMyInetAddresses()`
`static InetAddress`	`getNetwork(InetAddress remoteAddr, InetAddress defaultLocal)` Returns the correct outgoing IP address for network associated with remoteAddr.
`static int`	`getOpenPort(int start)` Attempts opening the requested port.
`static String`	`getPID()`
`static String`	`getStack(Throwable ex)` Given an Exception, return the stack trace as a String object
`private static String`	`innerSerialize(Object x)`
`static Object`	`interpretString(String content, String className)` Attempt to interpret the string content as an object of type className.
`private static boolean`	`isHexDigit(char input)`
`static boolean`	`isMyHostName(String hostName)`
`static boolean`	`isMyInetAddress(InetAddress addr)`
`static boolean`	`isSerializable(Class<?> _class)` Determines if a class is serializable by testing to see if at least one of the following conditions holds: it has a constructor with a single String parameter it has a fromString(`String`) method and a constructor with no parameters it has a fromString(`TokenParser`) method and a constructor with no parameters
`static boolean`	`isSerializable(Object obj)` Determines if the object is serializable by calling `isSerializable(Class)` with the class of the object.
`static String`	`log(String tag, String message, Throwable ex, boolean printStackTrace)` Deprecated. Use `Trace.log(String,String,Throwable,int)` instead
`static void`	`main(String[] args)`
`(package private) static String`	`makeLogHeader(String tag)` Deprecated.
`static String`	`makeUnprintablesVisible(String s)` Utility method to display a string with all escape characters visible.
`static Class<?>[]`	`objectsToClasses(Object[] o)` Given an array of objects, return an array of Class corresponding to the classes of the objects
`static StringBuilder`	`pad(StringBuilder buf, int n_spaces)`
`static String`	`padLeftTo(String s, char c, int n_spaces)`
`static String`	`padRightTo(String s, char c, int n_spaces)`
`static String`	`printui(String s, AgentUI ui, ParamsMap params, TransientAgent agent)`
`static Status`	`readPersistentFromProperties(String prefix, Object obj, CASAFilePropertiesMap properties)` Reads the persistent data from the data structures marked with the CasaPersistent annotation.
`static void`	`resetInetAddresses()` Resets the caches for `getMyAddresses()` and `getMyInetAddresses()`.
`static int`	`scanFor(String in, int startAt, String chars)` Scans for the first occurrence of any of the characters in chars starting at startAt, and returns the index (from the beginning of string, not startAt).
`static int`	`scanForWhiteSpace(String in, int startAt)` Scans for the first occurrence of any charcter less or equal to than ascii 32 (blank) starting at startAt, and returns the index (from the beginning of string, not startAt).
`static String`	`serialize(Collection<?> collection)` Given a collection of Objects, returns an String of the form:
`static String`	`serialize(Map<?,?> map)` Given an `Map` object, returns a String of the form:
`static String`	`serialize(Object... array)` Given an array of Objects, returns an String of the form:
`static String`	`serialize(Object x)` Returns the serialized Object x in the form:
`static boolean`	`sleepIgnoringInterrupts(long time, Runnable1<InterruptedException,Boolean> code)` Wait time milliseconds ignoring interrupts.
`static TransientAgent`	`startAnAgent(Class<?> theClass, String agentName, int port, Runnable1<TransientAgent,Void> code, String... argPairs)` Run an agent of type theClass named agentName on port port, optionally executing code once the agent is started up.
`void`	`test()`
`static LispObject`	`toCons(String... strings)` Put the argument strings into a cons list.
`static String`	`toQuotedString(Object x)` Returns the result x.toString() but surrounded by double-quotes and with any double-quotes originally in x.toString() escaped.
`static String`	`toQuotedString(String s)` Returns the s surrounded by double-quotes and with any double-quotes originally in s escaped.
`static String`	`unescape(String in, String escChars2)` Removes any backslash characters that had been added to in by a previous call to `escape(String,String)` with the same escChars.
`static Object`	`unserialize(String s, int startAt, String defaultClassName)` Attempts to construct an object from a serialized string.
`static Object`	`unserialize(String s, String className)` Calls `unserialize(s,0)` to return an object instantiated from s.
`static Object[]`	`unserializeArray(String s, int startAt, String className)` Returns an array of Objects instantiated from s.
`static Object[]`	`unserializeArray(String s, String className)` Behaves exactly the same as `unserializeArray(s,0)`.
`static Hashtable<Object,Object>`	`unserializeHashtable(String s, int startAt, String className)` Returns a `HashTable` object instantiated from s.
`static Hashtable<Object,Object>`	`unserializeHashtable(String s, String className)` Behaves exactly the same as `unserializeHashtable(s,0)`.
`static Object`	`unserializeQuotedString(String input, int mark, String className)`
`private static void`	`updateHostNames(InetAddress[] addresses)`
`static Status`	`writePersistentToProperties(String prefix, Object obj, CASAFilePropertiesMap properties)` Private recursive helper method for the public `#writePersistent()` method.

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

- Field Detail
  - ESCAPED_CHARACTERS
```
private static final String ESCAPED_CHARACTERS
```
    See Also:
    
    Constant Field Values
  - cachedLocalHost
```
private static InetAddress cachedLocalHost
```
  - cachedAddresses
```
static TreeMap<String,InetAddress[]> cachedAddresses
```
  - myInetAddresses
```
private static InetAddress[] myInetAddresses
```
    Used to cache the return value from getMyInetAddresses(). Set to null to get the addresses recaluclated.
  - myHostNames
```
private static String[] myHostNames
```
  - myAddresses
```
private static String[] myAddresses
```
    Used to cache the return value from getMyAddresses(). Set to null to get the addresses recaluclated.
- Constructor Detail
  - CASAUtil
```
public CASAUtil()
```
- Method Detail
  - getStack
```
public static String getStack(Throwable ex)
```
    Given an Exception, return the stack trace as a String object
    
    Parameters:
    
    ex - an Exception object; may be null, in which case the stack trace will the generated.
    
    Returns:
    
    A String object version of the stack trace of the Exception object
  - escape
```
public static String escape(String in,
                            String escChars2)
```
    Returns a new String that is in encoded with backslashes in front of every instance of any character that occurs in escChars. For example, casautil.escape("(())","()") ==> "\(\(\)\)" escape() always escapes the backslash character, so unescape(x,"") is exactly the same as escape(x,"\\").
    Note that escape() and unescape() reverse each others actions (if you start with escape). However escape applied a second time will re-encode the string (if there were some escaped charaters). This can be undone by two calls to unescape. Unescape applied to a string that has not been escaped may have unpredictable results.
```
 code                      value of s
 s = "(())";               (())
 s =   escape(s,"()");     \(\(\)\)
 s = unescape(s,"()");     (())
 s =   escape(s,"()");     \(\(\)\)
 s =   escape(s,"()");     \\(\\(\\)\\)
 s = unescape(s,"()");     \(\(\)\)
 s = unescape(s,"()");     (())
 
```
    Parameters:
    
    in - the input String to operate on
    
    escChars2 - a String containing the characters to escape (prepend with a backslash)
    
    Returns:
    
    always returns a new String, independent of in
    
    See Also:
    
    unescape(String, String), scanFor(String, int, String)
  - unescape
```
public static String unescape(String in,
                              String escChars2)
```
    Removes any backslash characters that had been added to in by a previous call to escape(String,String) with the same escChars. For example, casautil.unescape("\(\(\)\)","()") ==> "(())" unescape() always unescapes the backslash character, so unescape(x,"") is exactly the same as unescape(x,"\\").
    Note that escape() and unescape() reverse each others actions (if you start with escape). However escape applied a second time will re-encode the string (if there were some escaped characters). This can be undone by two calls to unescape. Unescape applied to a string that has not been escaped may have unpredictable results.
```
 code                      value of s
 s = "(())";               (())
 s =   escape(s,"()");     \(\(\)\)
 s = unescape(s,"()");     (())
 s =   escape(s,"()");     \(\(\)\)
 s =   escape(s,"()");     \\(\\(\\)\\)
 s = unescape(s,"()");     \(\(\)\)
 s = unescape(s,"()");     (())
 
```
    Parameters:
    
    in - the string to unescape
    
    escChars2 - the escaped characters to recognize
    
    Returns:
    
    the unescaped string
    
    See Also:
    
    escape(String,String), scanFor(String,int,String)
  - scanFor
```
public static int scanFor(String in,
                          int startAt,
                          String chars)
```
    Scans for the first occurrence of any of the characters in chars starting at startAt, and returns the index (from the beginning of string, not startAt). It will not pay attention to the any target character that is preceded by a backslash. Thus, scanFor(String, int, String) can be used in conjunction with {#link escape(String,String)} and unescape(String, String) to guarantee that an unknown string can be parsed. For example, you need to delineate an arbitrary string for future reading, but there may be further text after it. You can't just surround your string with {} because your string may contain } characters. Save your string, s, as s="{"+escape(s,"{}")+"}" you can safely use scanFor(s,1,"{}") to find the original terminating } delimiter. The expression:
```
 unescape(s.substring(scanFor(s,0,"{")+1,scanFor(s,scanFor(s,0,"{"),"}")),"{}")
 
```
    successfully retrieves the original string, no matter what was in the original string.
    Parameters:
    
    in -
    
    startAt -
    
    chars -
    
    Returns:
    
    the index of the first occurrence of a char in chars or -1 if none of the chars in chars are in in
    
    See Also:
    
    unescape(String, String), escape(String, String)
  - scanForWhiteSpace
```
public static int scanForWhiteSpace(String in,
                                    int startAt)
```
    Scans for the first occurrence of any charcter less or equal to than ascii 32 (blank) starting at startAt, and returns the index (from the beginning of string, not startAt). It will not pay attention to the any charater that is preceded by a backslash. Thus, scanForWhiteSpace() can be used in conjunction with escape() and unescape() to guarentee that an unknown string can be parsed.
    
    Parameters:
    
    in -
    
    startAt -
    
    Returns:
    
    the index of the first occurance of a char in chars or -1 if none of the chars in chars are in in
  - toQuotedString
```
public static String toQuotedString(String s)
```
    Returns the s surrounded by double-quotes and with any double-quotes originally in s escaped.
    
    Parameters:
    
    s -
    
    Returns:
    
    Returns the s surrounded by double-quotes and with any double-quotes originally in s escaped.
    
    See Also:
    
    escape(String, String)
  - fromQuotedString
```
public static String fromQuotedString(String s)
                               throws ParseException
```
    Returns exactly the same results as fromQuotedString(s,0).
    
    Parameters:
    
    s - the quoted string to de-quote
    
    Returns:
    
    an unquoted, unescaped string
    
    Throws:
    
    ParseException - if s can't be interpreted as a quoted string (eg: first non-white-space isn't '"') starting at startAt
  - fromQuotedString
```
public static String fromQuotedString(String s,
                                      int startAt)
                               throws ParseException
```
    Given a String (as generated from toQuotedString(String)) returns a String without the enclosing quotes and with an escaped double-quotes restored (unescaped). Extra chars after the closing quote are ignored.
    
    Parameters:
    
    s - the quoted string to de-quote
    
    startAt - the position is s to start at
    
    Returns:
    
    an unquoted, unescaped string
    
    Throws:
    
    ParseException - if s can't be interpreted as a quoted string (eg: first non-white-space isn't '"') starting at startAt
    
    See Also:
    
    unescape(String, String)
  - toQuotedString
```
public static String toQuotedString(Object x)
```
    Returns the result x.toString() but surrounded by double-quotes and with any double-quotes originally in x.toString() escaped.
    
    Parameters:
    
    x - the object to turn into a quoted string
    
    Returns:
    
    as above
    
    See Also:
    
    escape(String, String)
  - serialize
```
public static String serialize(Object x)
```
    Returns the serialized Object x in the form:
```
 '(' class-name ')' serialized-object
 
```
    where serialized-object is obtained by calling the object's toString() method and applying toQuotedString(String) to it. This will surround it is double-quotes and escape any quotes that happen to be in the string.
    Parameters:
    
    x - the object o serialize
    
    Returns:
    
    a String representing the object
    
    See Also:
    
    unserialize(String, String)
  - innerSerialize
```
private static String innerSerialize(Object x)
```
  - unserialize
```
public static Object unserialize(String s,
                                 String className)
                          throws ParseException
```
    Calls unserialize(s,0) to return an object instantiated from s.
    
    Parameters:
    
    s - the string containing the serialized object
    
    className - TODO
    
    Returns:
    
    an object instantiated from s
    
    Throws:
    
    ParseException - if a new object cannot be instantiated from s
  - unserialize
```
public static Object unserialize(String s,
                                 int startAt,
                                 String defaultClassName)
                          throws ParseException
```
    Attempts to construct an object from a serialized string. Serialized objects may be of the form:
```
 serial-obj    ::= null | hashtable | array | quoted-string | integer |
                   collection | simple-object
 null          ::= "null"
 hashtable     ::= "{" { serial-obj "=" serial-obj } { "," serial-obj "=" serial-obj }* "}"
 array         ::= "[" { serial-obj } { "," serial-obj }* "]"
 quoted-string ::= '"' text-with-escaped-quotes '"'
 integer       ::= {digit}+
 collection    ::= "(" class-name ")" array
 simple-object ::= "(" class-name ")" quoted-string
 
```
    simple-objects are all instantiated by trying several means in the following order:
    1. A String constructor
    2. A null constructor and calling fromString(String) method on the object
    3. A null constructor and calling fromString(TokenParser) method on the object
    A collection is instantiated by its null constructor and then calling the add(Object) method for each serialized object.
    Extra characters after the close of the object are ignored.
    If all the above fails, further attempts are made:
    1. if defaultClassName is not null, interpretString(String, String) is called to interpret raw characters as per the "several means" above.
    2. if the first non-whitespace character in s is "(", then the s is returned (as it may be either a Lisp expression or a FIPA-SL expression.
    Parameters:
    
    s - the String containing the serialized object(s)
    
    startAt - the position in the String s to start at
    
    className - TODO
    
    Returns:
    
    An object instantiated from s
    
    Throws:
    
    ParseException - if an object cannot be instantiated
  - interpretString
```
public static Object interpretString(String content,
                                     String className)
```
    Attempt to interpret the string content as an object of type className. This "attempt" is made by trying to find constructors or methods in class className as follows (in this order):
    1. public constructor className(String)
    2. public static className.toString(String)
    3. public static className.toString(TokenParser)
    Parameters:
    
    content - The String to interpret as above
    
    className - The name of the class the content is expected to be an object of
    
    Returns:
    
    An object of the type className, or null if content cannot be interpreted as an object of class className.
  - isSerializable
```
public static boolean isSerializable(Object obj)
```
    Determines if the object is serializable by calling isSerializable(Class) with the class of the object.
    
    Parameters:
    
    o - The object to inspect
    
    Returns:
    
    True if the object is serializable
    
    See Also:
    
    isSerializable(Class)
  - isSerializable
```
public static boolean isSerializable(Class<?> _class)
```
    Determines if a class is serializable by testing to see if at least one of the following conditions holds:
    - it has a constructor with a single String parameter
    - it has a fromString(String) method and a constructor with no parameters
    - it has a fromString(TokenParser) method and a constructor with no parameters
    Parameters:
    
    _class - The Class to inspect.
    
    Returns:
    
    true if the class is serializatable (the above conditions hold).
  - serialize
```
public static String serialize(Map<?,?> map)
```
    Given an Map object, returns a String of the form:
```
   "{" { serial-obj "=" serial-obj } { "," serial-obj "=" serial-obj }* "}"
 
```
    (See unserialize(String, int, String) for the definition of serial-obj.)
    Parameters:
    
    map - the data structure to serialize
    
    Returns:
    
    a string representing map
  - serialize
```
public static String serialize(Object... array)
```
    Given an array of Objects, returns an String of the form:
```
   "[" { serial-obj } { "," serial-obj }* "]"
 
```
    (See unserialize(String, int, String) for the definition of serial-obj.)
    Parameters:
    
    array - the array to serialize
    
    Returns:
    
    a string representing array
  - serialize
```
public static String serialize(Collection<?> collection)
```
    Given a collection of Objects, returns an String of the form:
```
   "(" class-name ")" array
 
```
    (See serialize(Object[]) for the definition of array.)
    Parameters:
    
    collection - the Collection to serialize
    
    Returns:
    
    a string representing array
  - unserializeHashtable
```
public static Hashtable<Object,Object> unserializeHashtable(String s,
                                                            String className)
                                                     throws ParseException
```
    Behaves exactly the same as unserializeHashtable(s,0).
    
    Parameters:
    
    s - the String to interpret a Collection from.
    
    className - TODO
    
    Returns:
    
    an object interpreted from s
    
    Throws:
    
    ParseException - if an object cannot be instantiated from s
  - unserializeHashtable
```
public static Hashtable<Object,Object> unserializeHashtable(String s,
                                                            int startAt,
                                                            String className)
                                                     throws ParseException
```
    Returns a HashTable object instantiated from s. s is expected to be of the form:
```
   "(" class-name ")" array
 
```
    See unserializeArray(String, int, String) for the definition of array. Extra characters after the end of the object are ignored.
    Parameters:
    
    s - the String to interpret a Collection from.
    
    startAt - the position in s to start parsing
    
    className - TODO
    
    Returns:
    
    an object interpreted from s
    
    Throws:
    
    ParseException - if an object cannot be instantiated from s
  - unserializeQuotedString
```
public static Object unserializeQuotedString(String input,
                                             int mark,
                                             String className)
                                      throws ParseException
```
    Throws:
    
    ParseException
  - unserializeArray
```
public static Object[] unserializeArray(String s,
                                        String className)
                                 throws ParseException
```
    Behaves exactly the same as unserializeArray(s,0).
    
    Parameters:
    
    s - the String to interpret an array of objects from.
    
    className - TODO
    
    Returns:
    
    an object interpreted from s
    
    Throws:
    
    ParseException - if an object cannot be instantiated from s
  - unserializeArray
```
public static Object[] unserializeArray(String s,
                                        int startAt,
                                        String className)
                                 throws ParseException
```
    Returns an array of Objects instantiated from s. s is expected to be of the form:
```
   "[" { serial-obj } { "," serial-obj }* "]"
 
```
    See unserialize(String, int, String) for the definition of serial-obj. Extra characters after the end of the object are ignored.
    Parameters:
    
    s - the String to interpret an array of Objects from.
    
    startAt - the position in s to start parsing
    
    className - TODO
    
    Returns:
    
    an array of Objects interpreted from s
    
    Throws:
    
    ParseException - if an object cannot be instantiated from s
  - main
```
public static void main(String[] args)
```
  - encode
```
public static String encode(String input,
                            boolean escapeAmp)
```
    Given a string with "binary" data (ASCII codes less than 32), returns a string with each of the non-printable characters (less than ASCII 32) substituted with "%hh", where "h" is a hex digit.
    
    Parameters:
    
    input - the string to encode
    
    escapeAmp -
    
    Returns:
    
    the encoded string
  - pad
```
public static StringBuilder pad(StringBuilder buf,
                                int n_spaces)
```
  - padLeftTo
```
public static String padLeftTo(String s,
                               char c,
                               int n_spaces)
```
  - padRightTo
```
public static String padRightTo(String s,
                                char c,
                                int n_spaces)
```
  - decode
```
public static String decode(String input,
                            boolean decodeAmp)
```
    Given a string with encoded "binary" data ("%hh" for ASCII codes less than 32), returns a string with each of the encoded characters replaced by the approriate "binary" (non-printable) character.
    
    Parameters:
    
    input - the string to encode
    
    decodeAmp -
    
    Returns:
    
    the encoded string
  - isHexDigit
```
private static boolean isHexDigit(char input)
```
  - getLocalHost
```
public static InetAddress getLocalHost()
```
    This method should be used by CASA in place of InetAddress.getLocalHost(). Since the firewalls etc. may cause casa to have to use a different local host IP address, an local host ip address may be stored in the file CASA.casa (a CASA-format file) under the property "router". This method will look in this file (if it exists) before using the InetAddress.getLocalHost() method to get the local host.
    
    Returns:
    
    the InetAddress for the local host
  - byteArrayAsHexString
```
public static String byteArrayAsHexString(byte[] buffer)
```
  - objectsToClasses
```
public static Class<?>[] objectsToClasses(Object[] o)
```
    Given an array of objects, return an array of Class corresponding to the classes of the objects
    
    Parameters:
    
    o - the array of Objects
    
    Returns:
    
    an array of Class objects with each element being the class of the object in the corresponding element of o.
  - formatWidth
```
public static String formatWidth(String text,
                                 int lineWidth,
                                 String autoIndent)
```
  - getDateAsString
```
public static String getDateAsString()
```
    Returns the current time as a formated date string in the default format
    
    Returns:
    
    The formated date string
  - getDateAsString
```
public static String getDateAsString(String format)
```
    Returns the current time as a formated date string
    
    Parameters:
    
    format - The format of the date string according to DateFormat.format(Date).
    
    Returns:
    
    The formated date string
  - getDateAsString
```
public static String getDateAsString(Long timeSpec)
```
    Converts the long millisecond time to a formated date string in the default format
    
    Parameters:
    
    timeSpec - the time in milliseconds to convert to a date string
    
    Returns:
    
    The formated date string
  - getDateAsString
```
public static String getDateAsString(Long timeSpec,
                                     String format)
```
    Converts the long millisecond time to a formated date string
    
    Parameters:
    
    timeSpec - the time in milliseconds to convert to a date string
    
    format - The format of the date string according to DateFormat.format(Date).
    
    Returns:
    
    The formated date string
  - getOpenPort
```
public static int getOpenPort(int start)
```
    Attempts opening the requested port. If that port is not available, it attempts to open the next one. There is no lock placed on the port number returned. It may be stolen by a competing process.
    
    Parameters:
    
    start -
    
    Returns:
    
    open
  - writePersistentToProperties
```
public static Status writePersistentToProperties(String prefix,
                                                 Object obj,
                                                 CASAFilePropertiesMap properties)
```
    Private recursive helper method for the public #writePersistent() method.
    
    Parameters:
    
    prefix - A prefix to add to this
    
    obj - The object to write out.
    
    See Also:
    
    #writePersistent()
  - readPersistentFromProperties
```
public static Status readPersistentFromProperties(String prefix,
                                                  Object obj,
                                                  CASAFilePropertiesMap properties)
```
    Reads the persistent data from the data structures marked with the CasaPersistent annotation. This method is static because this allows it to be used by the LAC class as well.
    
    Parameters:
    
    prefix -
    
    obj -
    
    properties -
  - findSubclassesOf
```
public static List<Class<?>> findSubclassesOf(Class<?> superclass)
```
    Returns a list of all the proper subclasses of the parameter class.
    Caution 1: This can take a very long time -- in the order of seconds.
    Caution 2: This will ONLY return the classes that are LOADED: if the class just hasn't been loaded yet, it will not be counted.
    
    Parameters:
    
    superclass - The class to return all the subclasses of.
    
    Returns:
    
    All the proper subclasses of the parameter class.
  - findSubClassesOf
```
public static List<Class<?>> findSubClassesOf(String pckgname,
                                              Class<?> superclass)
```
    Returns a list of all the proper subclasses of the parameter class with the parameter package.
    Caution 1: This can take a very long time -- in the order of seconds.
    Caution 2: This will ONLY return the classes that are LOADED: if the class just hasn't been loaded yet, it will not be counted.
    
    Parameters:
    
    pckgname - The name of package to search
    
    superclass - The class to return all the subclasses of.
    
    Returns:
    
    All the proper subclasses of the parameter class with the package.
  - test
```
public void test()
```
  - bytesToString
```
public static String bytesToString(byte[] bb,
                                   String encoding)
```
    Parameters:
    
    bb -
    
    encoding - The encoding (eg: "UTF-8").
    
    Returns:
    
    The String version of bb encoded in encoding or (if that encoding fails or encoding is null) the system default encoding.
  - makeUnprintablesVisible
```
public static String makeUnprintablesVisible(String s)
```
    Utility method to display a string with all escape characters visible. Useful to show the buffer, which could have binary data in it.
    
    Parameters:
    
    s - The string that may contain non-printable characters.
    
    Returns:
    
    A version of s with all the non-printables shown as escape sequences.
  - findOntology
```
public static Ontology findOntology(TransientAgent agent,
                                    ParamsMap params,
                                    AgentUI ui,
                                    Environment env)
```
  - printui
```
public static String printui(String s,
                             AgentUI ui,
                             ParamsMap params,
                             TransientAgent agent)
```
  - getInetAddressesForPrimitive
```
private static InetAddress[] getInetAddressesForPrimitive(InetAddress addr)
```
  - getInetAddressesFor
```
public static InetAddress[] getInetAddressesFor(InetAddress addr)
```
  - resetInetAddresses
```
public static void resetInetAddresses()
```
    Resets the caches for getMyAddresses() and getMyInetAddresses(). Call this method to cause the recalculation of the InetAddresses on the next call to these methods.
  - updateHostNames
```
private static void updateHostNames(InetAddress[] addresses)
```
  - isMyHostName
```
public static boolean isMyHostName(String hostName)
```
  - getMyHostNames
```
public static String[] getMyHostNames()
```
  - isMyInetAddress
```
public static boolean isMyInetAddress(InetAddress addr)
```
    Parameters:
    
    addr -
    
    Returns:
    
    true iff the parameter addr is one of local hosts addresses.
  - getMyInetAddresses
```
public static InetAddress[] getMyInetAddresses()
```
    Returns:
    
    all the computer's Inet4 addresses, do this using BOTH InetAddress#getLocalHost() and the local {@link #getLocalHost()}.
  - getAddressesFor
```
public static String[] getAddressesFor(InetAddress addr)
```
  - getMyAddresses
```
public static String[] getMyAddresses()
```
    Returns:
    
    all the computer's Inet4 addresses as a string array.
  - getNetwork
```
public static InetAddress getNetwork(InetAddress remoteAddr,
                                     InetAddress defaultLocal)
```
    Returns the correct outgoing IP address for network associated with remoteAddr. The local machine may have several networkInterfaces, and this will determine which one of them to use.
    
    Parameters:
    
    remoteAddr -
    
    defaultLocal - the default to return if none is found.
    
    Returns:
    
    Throws:
    
    Exception
  - fillSubclasses
```
public static Map<String,Class<?>> fillSubclasses(Map<String,Class<?>> map,
                                                  Class<?> superclass,
                                                  String target,
                                                  String suffix)
```
    Search for a class named target+suffix that is a subclass of superclass. Regardless of weather this class is found, return a map of all prefixes-to-suffixes of classes that are subclasses of superclass. In the event that a match is found in map that isn't a subtype, it is eliminated and the search is performed as it it wasn't there.
    
    Parameters:
    
    map - If there is already a map, this should be filled, which acts as a cache -- eliminating the search time. If this null the preferences and possibly run-time sub classes will be searched.
    
    superclass - The class to look for subclasses of. This may NOT be null;
    
    target - The prefix part of the class name we are looking for, which is also used as the index to this class in the return Map. If this is null, an extensive search will always be made for all subclasses matching the suffix part.
    
    suffix - The suffice pat the class name (the class name we looking for is prefix+suffix). If this is null, it will be taken as the name of the superclass.
    
    Returns:
    
    A Map from prefix to classes for all the subclasses of the superclass. This may or may not contain the target.
  - sleepIgnoringInterrupts
```
public static boolean sleepIgnoringInterrupts(long time,
                                              Runnable1<InterruptedException,Boolean> code)
```
    Wait time milliseconds ignoring interrupts.
    
    Parameters:
    
    time - The time to wait.
    
    code - If an intterrupt happens during the sleep, Runnable1.run(Object) on code is called. If the run() returns true, this method aborts the sleep and returns false. This parameter may be null, in which case, this method sleeps the entire time.
    
    Returns:
    
    True if this method waited the full time; false if run() is executed and returns true.
  - getAbstractProcessInScopeSilent
```
public static AbstractProcess getAbstractProcessInScopeSilent()
```
    Attempt to find an in-scope agent.
    1. If the current thread is an agent, return this thread (casted to an AbstractProcess
    2. Else if the current thread is a AbstractProcess.Subthread created with AbstractProcess.makeSubthread(Runnable) or AbstractProcess.makeSubthread(Runnable, String) then return the agent recorded in the SubThread.
    3. Else if the current thread is in a threadGroup with an agent, then try to find the agent who created the threadGroup and return that agent.
    4. Else if the current thread has a field "agent" (typically created using ThreadLocal) of type AbstractProcess then return this agent.
    5. Else return null.
    Returns:
    
    as above.
  - getAbstractProcessInScope
```
public static AbstractProcess getAbstractProcessInScope()
```
    Attempt to find an in-scope agent. If it's not found, logs a warning message to Sysout.
    
    Returns:
    
    The found agent.
    
    See Also:
    
    getAbstractProcessInScopeSilent()
  - log
```
@Deprecated
public static String log(String tag,
                                     String message,
                                     Throwable ex,
                                     boolean printStackTrace)
```
    Deprecated. Use Trace.log(String,String,Throwable,int) instead
    
    Logs the message if tag is in effect to the in-scope agent's log files, windows, etc. If no agent can be found in scope, does the best-effort to log to System output.
    
    Parameters:
    
    tag - A trace tag: if an agent can't be found in scope this is ignored
    
    message - The message to log
    
    ex - If ex is not null, the stack dump is appended to the message.
    
    printStackTrace - set to true to print a stack trace (note that if ex is not null, the trace will be printed anyway).
    
    Returns:
    
    The String (minus the generated log header) printed to the log
    
    See Also:
    
    Trace.log(String, String), getAbstractProcessInScope()
  - makeLogHeader
```
@Deprecated
static String makeLogHeader(String tag)
```
    Deprecated.
  - toCons
```
public static LispObject toCons(String... strings)
```
    Put the argument strings into a cons list.
    
    Parameters:
    
    strings - the strings that will form the atoms in the cons list.
    
    Returns:
    
    The cons list.
  - callMethod
```
public static Object callMethod(Class<?> cls,
                                String methodName,
                                Object target,
                                Class<?>[] paramTypes,
                                Object[] params)
                         throws NoSuchMethodException,
                                InvocationTargetException,
                                IllegalArgumentException,
                                IllegalAccessException,
                                NullPointerException,
                                SecurityException,
                                ExceptionInInitializerError
```
    Calls a method by name alone, without requiring the compiler to know about it. This is particularly useful for platform-specific calls such as those of the apple com.apple.mrj.MRJFileUtils class. For example:
```
   try {
     CASAUtil.callMethod(Class.forName("com.apple.mrj.MRJFileUtils"), 
                         "openURL", 
                         null, 
                         new Class[]{String.class}, 
                         new Object[]{url});
   }
   catch(Throwable ex) {}
 
```
    Parameters:
    
    cls - The class of target object. If cls is null, but target is specified, then cls is assumed to be the runtime type of target.
    
    methodName - The name of the method to invoke.
    
    target - The object on which to call this method. May be null if this is a methodName is the name of a static method.
    
    paramTypes - The types of the arguments.
    
    params - The arguments
    
    Returns:
    
    The result of invoking the method with the specified parameters.
    
    Throws:
    
    NoSuchMethodException
    
    InvocationTargetException
    
    IllegalArgumentException
    
    IllegalAccessException
    
    NullPointerException
    
    SecurityException
    
    ExceptionInInitializerError
  - startAnAgent
```
public static TransientAgent startAnAgent(Class<?> theClass,
                                          String agentName,
                                          int port,
                                          Runnable1<TransientAgent,Void> code,
                                          String... argPairs)
```
    Run an agent of type theClass named agentName on port port, optionally executing code once the agent is started up. This can be really useful for testing new agents.
    
    Parameters:
    
    theClass - The class of the agent to start.
    
    agentName - The name of the new agent.
    
    port - The port for the new agent.
    
    code - The code to execute once the agent starts up -- it will be passed the actual agent.
    
    argPairs - key/value pairs of arguments to pass in the agent's constructor (must be even).
    
    Returns:
    
    the started agent, or null if the agent couldn't be started. when it is called; may be null.
  - getPID
```
public static String getPID()
```
    Returns:
    
    the runtime PID as a string, or best attempt. If we can't get to the actual PID, then return the name of the JVM.

Class CASAUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ESCAPED_CHARACTERS

cachedLocalHost

cachedAddresses

myInetAddresses

myHostNames

myAddresses

Constructor Detail

CASAUtil

Method Detail

getStack

escape

unescape

scanFor

scanForWhiteSpace

toQuotedString

fromQuotedString

fromQuotedString

toQuotedString

serialize

innerSerialize

unserialize

unserialize

interpretString

isSerializable

isSerializable

serialize

serialize

serialize

unserializeHashtable

unserializeHashtable

unserializeQuotedString

unserializeArray

unserializeArray

main

encode

pad

padLeftTo

padRightTo

decode

isHexDigit

getLocalHost

byteArrayAsHexString

objectsToClasses

formatWidth

getDateAsString

getDateAsString

getDateAsString

getDateAsString

getOpenPort

writePersistentToProperties

readPersistentFromProperties

findSubclassesOf

findSubClassesOf

test

bytesToString

makeUnprintablesVisible

findOntology

printui

getInetAddressesForPrimitive

getInetAddressesFor

resetInetAddresses

updateHostNames

isMyHostName

getMyHostNames

isMyInetAddress

getMyInetAddresses

getAddressesFor

getMyAddresses

getNetwork

fillSubclasses

sleepIgnoringInterrupts

getAbstractProcessInScopeSilent

getAbstractProcessInScope

log