RuntimeUtility (org.refcodes:refcodes-runtime 1.0.0 API)

java.lang.Object
- org.refcodes.runtime.RuntimeUtility

```
public final class RuntimeUtility
extends Object
```
Utility for acquiring runtime information on software systems, classes or objects.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Class<?>`	`geCallerType()` Returns the type of the (`Class`) belonging to the direct caller of this method.
`static StackTraceElement`	`getCallerStackTraceElement()` Returns the stack trace element belonging to the direct caller of this method.
`static StackTraceElement`	`getCallerStackTraceElement(Class<?>... aCallees)` Same as `getCallerStackTraceElement(Class)` with the difference that the passed callees are tried out one after the other until the first caller determined for a callee is returned.
`static StackTraceElement`	`getCallerStackTraceElement(Class<?> aCallee)` Returns the stack trace element belonging to the caller of the callee.
`static StackTraceElement`	`getCallerStackTraceElement(String... aCalleeClassNames)` Same as `getCallerStackTraceElement(String)` with the difference that the passed callees are tried out one after the other until the first caller determined for a callee is returned.
`static StackTraceElement`	`getCallerStackTraceElement(String aCalleeClassName)` Returns the stack trace element belonging to the caller of the callee.
`static Class<?>`	`getCallerType(Class<?>... aCallees)` Same as `getCallerType(Class)` with the difference that the passed callees are tried out one after the other until the first caller determined for a callee is returned.
`static Class<?>`	`getCallerType(Class<?> aCallee)` Returns the type of the (`Class`) belonging to the caller of the callee.
`static Class`	`getMainClass()` Returns the main class launching the application.
`static Long`	`getPid()` Bad hack to get the JVM's (process ID) PID of the process running your JVM instance.
`static boolean`	`kill(Long aPid)` Bad hack to kill an OS thread by PID.
`static Process`	`killProcess(Long aPid)` Bad hack to kill an OS thread by PID.
`static File`	`toAppBaseDir()` Generates the base path relative to the given class location.
`static List<File>`	`toAppConfigDirs()` Returns a list of (existing) folders which are candidates for external resources.
`static Class<?>`	`toClass(StackTraceElement aStackTraceElement)` Retrieves the `Class` type to which the `StackTraceElement` belongs.
`static String`	`toClassName()` Retrieves the class name of the caller of this method without the fully qualified package name part.
`static String`	`toClassName(StackTraceElement aStackTraceElement)` Returns the class name part from a stack trace element.
`static String`	`toClassName(String aFullyQualifiedClassName)` Returns the class name part from a fully qualified class name (which has the fully qualified package name as part of its name).
`static <T> T`	`toClone(T aObj)` A `Cloneable` object cannot directly be cloned by casting it to be `Cloneable` :-( Thereforee this method does the job.
`static String`	`toFullyQualifiedClassName()` Retrieves the fully qualified method name of the caller of this method.
`static String`	`toFullyQualifiedClassName(StackTraceElement aStackTraceElement)` Retrieves the fully qualified class name from a stack trace element.
`static String`	`toFullyQualifiedMethodName()` Retrieves the fully qualified method name of the caller of this method.
`static String`	`toFullyQualifiedMethodName(StackTraceElement aStackTraceElement)` Retrieves the fully qualified method name from a stack trace element.
`static String`	`toFullyQualifiedPackageName()` Retrieves the fully qualified package name of the caller of this method without the class name part.
`static String`	`toFullyQualifiedPackageName(StackTraceElement aStackTraceElement)` Retrieves the fully qualified package name from a stack trace element.
`static String`	`toFullyQualifiedPackageName(String aFullyQualifiedClassName)` Returns the fully qualified package name part from a fully qualified class name (which has the fully qualified package name as part of its name).
`static String`	`toMethodName()` Retrieves the fully qualified method name of the caller of this method.
`static String`	`toMethodName(StackTraceElement aStackTraceElement)` Retrieves the method name from a stack trace element.
`static String`	`toStackTrace()` Gets the stack trace for the current thread.
`static String`	`toString(String aToString, String aSuperToString)` Creates a string of a super class's `Object.toString()` method and the provided "toString" text.

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

- Method Detail
  - toStackTrace
```
public static String toStackTrace()
```
    Gets the stack trace for the current thread.
    
    Returns:
    
    The stack trace from the current thread.
  - getCallerStackTraceElement
```
public static StackTraceElement getCallerStackTraceElement()
```
    Returns the stack trace element belonging to the direct caller of this method. When you use this method in your code, you get the stack trace element of your method (invoking this method).
    
    Returns:
    
    The stack element of the direct caller of this method.
  - getCallerStackTraceElement
```
public static StackTraceElement getCallerStackTraceElement(Class<?> aCallee)
```
    Returns the stack trace element belonging to the caller of the callee. Best you do not use the Object.getClass() method, instead use YourClass.class as as of inheritance, Object.getClass() returns the wrong type not being the actual callee!
    
    Parameters:
    
    aCallee - The callee class which wants to find out who called it.
    
    Returns:
    
    The stack element of the caller of the callee or null if the callee is not present or if there is no caller of the given callee in the current stack trace.
  - getCallerStackTraceElement
```
public static StackTraceElement getCallerStackTraceElement(Class<?>... aCallees)
```
    Same as getCallerStackTraceElement(Class) with the difference that the passed callees are tried out one after the other until the first caller determined for a callee is returned.
  - getCallerStackTraceElement
```
public static StackTraceElement getCallerStackTraceElement(String aCalleeClassName)
```
    Returns the stack trace element belonging to the caller of the callee. Best you do not use the Object.getClass() method, instead use YourClass.class as as of inheritance, Object.getClass() returns the wrong type not being the actual callee!
    
    Parameters:
    
    aCalleeClassName - The callee class name which wants to find out who called it.
    
    Returns:
    
    The stack element of the caller of the callee or null if the callee is not present or if there is no caller of the given callee in the current stack trace.
  - getCallerStackTraceElement
```
public static StackTraceElement getCallerStackTraceElement(String... aCalleeClassNames)
```
    Same as getCallerStackTraceElement(String) with the difference that the passed callees are tried out one after the other until the first caller determined for a callee is returned.
  - geCallerType
```
public static Class<?> geCallerType()
```
    Returns the type of the (Class) belonging to the direct caller of this method. When you use this method in your code, you get the Class of your method (invoking this method).
    
    Returns:
    
    The type (Class) of the direct caller of this method.
  - getCallerType
```
public static Class<?> getCallerType(Class<?> aCallee)
```
    Returns the type of the (Class) belonging to the caller of the callee.
    
    Parameters:
    
    aCallee - The callee class which wants to find out who called it.
    
    Returns:
    
    The type (Class) of the caller of the caller of this method.
  - getCallerType
```
public static Class<?> getCallerType(Class<?>... aCallees)
```
    Same as getCallerType(Class) with the difference that the passed callees are tried out one after the other until the first caller determined for a callee is returned.
  - toClass
```
public static Class<?> toClass(StackTraceElement aStackTraceElement)
```
    Retrieves the Class type to which the StackTraceElement belongs.
    
    Parameters:
    
    aStackTraceElement - The StackTraceElement for which to get the according Class.
    
    Returns:
    
    The type (Class) of the according StackTraceElement.
  - toMethodName
```
public static String toMethodName(StackTraceElement aStackTraceElement)
```
    Retrieves the method name from a stack trace element.
    
    Parameters:
    
    aStackTraceElement - The stack trace element from which to retrieve the method name.
    
    Returns:
    
    The method name or null in case the stack trace element was null.
  - toClassName
```
public static String toClassName(StackTraceElement aStackTraceElement)
```
    Returns the class name part from a stack trace element. Retrieves the fully qualified class name from a stack trace element.
    
    Parameters:
    
    aStackTraceElement - The stack trace element from which to retrieve the class name.
    
    Returns:
    
    The class name without the package declaration or null in case the stack trace element was null.
  - toFullyQualifiedClassName
```
public static String toFullyQualifiedClassName(StackTraceElement aStackTraceElement)
```
    Retrieves the fully qualified class name from a stack trace element.
    
    Parameters:
    
    aStackTraceElement - The stack trace element from which to retrieve the fully qualified class name.
    
    Returns:
    
    The fully qualified class name or null in case the stack trace element was null.
  - toFullyQualifiedMethodName
```
public static String toFullyQualifiedMethodName(StackTraceElement aStackTraceElement)
```
    Retrieves the fully qualified method name from a stack trace element. This adds the method name to the fully qualified path name separated by a hash "#".
    
    Parameters:
    
    aStackTraceElement - The stack trace element from which to retrieve the fully qualified method name.
    
    Returns:
    
    The fully qualified method name or null in case the stack trace element was null.
  - toFullyQualifiedClassName
```
public static String toFullyQualifiedClassName()
```
    Retrieves the fully qualified method name of the caller of this method. This adds the method name to the caller's fully qualified path name separated by a hash "#".
    
    Returns:
    
    The fully qualified method name.
  - toFullyQualifiedMethodName
```
public static String toFullyQualifiedMethodName()
```
    Retrieves the fully qualified method name of the caller of this method. This adds the method name to the caller's fully qualified path name separated by a hash "#".
    
    Returns:
    
    The fully qualified method name.
  - toMethodName
```
public static String toMethodName()
```
    Retrieves the fully qualified method name of the caller of this method. This adds the method name to the caller's fully qualified path name separated by a hash "#".
    
    Returns:
    
    The fully qualified method name.
  - toClassName
```
public static String toClassName()
```
    Retrieves the class name of the caller of this method without the fully qualified package name part.
    
    Returns:
    
    The class name.
  - toFullyQualifiedPackageName
```
public static String toFullyQualifiedPackageName()
```
    Retrieves the fully qualified package name of the caller of this method without the class name part.
    
    Returns:
    
    The fully qualified package name.
  - toFullyQualifiedPackageName
```
public static String toFullyQualifiedPackageName(StackTraceElement aStackTraceElement)
```
    Retrieves the fully qualified package name from a stack trace element.
    
    Parameters:
    
    aStackTraceElement - The stack trace element from which to retrieve the fully qualified package name.
    
    Returns:
    
    The fully qualified package name.
  - toClassName
```
public static String toClassName(String aFullyQualifiedClassName)
```
    Returns the class name part from a fully qualified class name (which has the fully qualified package name as part of its name).
    
    Parameters:
    
    aFullyQualifiedClassName - The fully qualified class name.
    
    Returns:
    
    The class name without the package declaration.
  - toFullyQualifiedPackageName
```
public static String toFullyQualifiedPackageName(String aFullyQualifiedClassName)
```
    Returns the fully qualified package name part from a fully qualified class name (which has the fully qualified package name as part of its name).
    
    Parameters:
    
    aFullyQualifiedClassName - The fully qualified class name.
    
    Returns:
    
    The fully qualified package name without the class name.
  - toClone
```
public static <T> T toClone(T aObj)
                     throws CloneNotSupportedException
```
    A Cloneable object cannot directly be cloned by casting it to be Cloneable :-( Thereforee this method does the job. Citation From Josh Bloch's Effective Java: "The Cloneable interface was intended as a mixin interface for objects to advertise that they permit cloning. Unfortunately it fails to serve this purpose ... This is a highly atypical use of interfaces and not one to be emulated ... In order for implementing the interface to have any effect on a class, it and all of its superclasses must obey a fairly complex, unenforceable and largely undocumented protocol"
    
    Parameters:
    
    aObj - The object to be cloned.
    
    Returns:
    
    The cloned object.
    
    Throws:
    
    CloneNotSupportedException - in case the object cannot be cloned.
    
    See Also:
    
    "http://stackoverflow.com/questions/1138769/why-is-the-clone-method-protected-in-java-lang-object"
  - toString
```
public static String toString(String aToString,
                              String aSuperToString)
```
    Creates a string of a super class's Object.toString() method and the provided "toString" text.
    
    Parameters:
    
    aToString - The provided "toString" text.
    
    aSuperToString - A super class's Object.toString() method's String.
    
    Returns:
    
    The "concatenated" and formatted new String to be returned by an implementing class's Object.toString() method.
  - getPid
```
public static Long getPid()
```
    Bad hack to get the JVM's (process ID) PID of the process running your JVM instance.
    
    Returns:
    
    The PID (process ID) of the JVM running your thread.
    
    See Also:
    
    "http://stackoverflow.com/questions/35842/how-can-a-java-program-get-its-own-process-id"
  - killProcess
```
public static Process killProcess(Long aPid)
                           throws IOException
```
    Bad hack to kill an OS thread by PID. The current threads does not wait till the operation finished.
    
    Parameters:
    
    aPid - The process ID (PID) of the process to kill.
    
    Returns:
    
    The Process object representing the kill operation. This instance will let you wait till the operation finished Process.waitFor() and provides access to the Process.exitValue()
    
    Throws:
    
    IOException - Thrown in case of failing to successfully execute the kill operation.
    
    See Also:
    
    "http://stackoverflow.com/questions/9573696/kill-a-process-based-on-pid-in-java", "http://stackoverflow.com/questions/2950338/how-can-i-kill-a-linux-process-in-java-with-sigkill-process-destroy-does-sigte"
  - kill
```
public static boolean kill(Long aPid)
                    throws IOException,
                           InterruptedException
```
    Bad hack to kill an OS thread by PID. The current threads does wait till the operation finished.
    
    Parameters:
    
    aPid - The process ID (PID) of the process to kill.
    
    Returns:
    
    True in case killing the process was successful (e.g. the kill operation returned an exit code 0), else false.
    
    Throws:
    
    IOException - Thrown in case of failing to successfully execute the kill operation.
    
    InterruptedException
    
    See Also:
    
    "http://stackoverflow.com/questions/9573696/kill-a-process-based-on-pid-in-java", "http://stackoverflow.com/questions/2950338/how-can-i-kill-a-linux-process-in-java-with-sigkill-process-destroy-does-sigte"
  - toAppBaseDir
```
public static File toAppBaseDir()
                         throws IOException
```
    Generates the base path relative to the given class location. Depending on the runtime, the path is truncated till the required path is determined.
    
    Returns:
    
    The base path of this application.
    
    Throws:
    
    IOException - thrown in case determining the path failed due to I/O.
  - getMainClass
```
public static Class getMainClass()
```
    Returns the main class launching the application.
    
    Returns:
    
    The main class.
  - toAppConfigDirs
```
public static List<File> toAppConfigDirs()
                                  throws IOException
```
    Returns a list of (existing) folders which are candidates for external resources. The applications base directory (where your JAR or your classes reside) is taken and a list of directories relative to this base directory is generated as defined in the RuntimeConsts.CONFIG_DIR_NAMES: The actual directories being returned (in case them exist) are as follows, relative to your applications base directory:
    - ../config"
    - ../etc"
    - ../settings"
    - ../.config"
    - ../settings"
    - ."
    - ./config"
    - ./etc"
    - ./settings"
    - ./.config"
    - ./settings"
    Returns:
    
    A list containing potential application configuration folders.
    
    Throws:
    
    IOException - Thrown in case there were File related problems determining the folders.

Class RuntimeUtility

Method Summary

Methods inherited from class java.lang.Object

Method Detail

toStackTrace

getCallerStackTraceElement

getCallerStackTraceElement

getCallerStackTraceElement

getCallerStackTraceElement

getCallerStackTraceElement

geCallerType

getCallerType

getCallerType

toClass

toMethodName

toClassName

toFullyQualifiedClassName

toFullyQualifiedMethodName

toFullyQualifiedClassName

toFullyQualifiedMethodName

toMethodName

toClassName

toFullyQualifiedPackageName

toFullyQualifiedPackageName

toClassName

toFullyQualifiedPackageName

toClone

toString

getPid

killProcess

kill

toAppBaseDir

getMainClass

toAppConfigDirs