Module org.refcodes.runtime
Package org.refcodes.runtime

Class RuntimeUtility

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

    • Method Detail

      • toBootstrapStandardOut

        public static PrintStream toBootstrapStandardOut()
        Returns the original PrintStream for STDOUT as initialized by the JVM at bootstrapping time (the System.out PrintStream may have got modified by libraries or frameworks).
        Returns:
        The real PrintStream as initially set.

      • toBootstrapStandardError

        public static PrintStream toBootstrapStandardError()
        Returns the original PrintStream for STDERR as initialized by the JVM at bootstrapping time (the System.err PrintStream may have got modified by libraries or frameworks).
        Returns:
        The real PrintStream as initially set.

      • toBootstrapStandardIn

        public static InputStream toBootstrapStandardIn()
        Returns the original InputStream for STDIN as initialized by the JVM at bootstrapping time (he System.in InputStream may have got modified by libraries or frameworks).
        Returns:
        The real InputStream as initially set.

      • isUnderTest

        public static boolean isUnderTest()
        Determines whether this code is executed from inside a unit test or not.
        Returns:
        True in case if executed from within a unit test.

      • 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 StackTraceElement 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 StackTraceElement 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​(StackTraceElement aCallee)
        Returns the StackTraceElement 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 StackTraceElement 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.
        Parameters:
        aCallees - the callees
        Returns:
        the caller StackTraceElement

      • 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.
        Parameters:
        aCalleeClassNames - the callee class names
        Returns:
        the caller StackTraceElement

      • getCallerStackTraceElement

        public static StackTraceElement getCallerStackTraceElement​(String aCalleeClassName)
        Returns the StackTraceElement belonging to the caller of the callee. The callee can also be a package namespace where the matchee's must begin with the given package namespace.
        Parameters:
        aCalleeClassName - The callee class name or package namespace 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.

      • toBestCallerStackTraceElement

        public static StackTraceElement toBestCallerStackTraceElement​(String aCalleeClassName)
        Returns the best matching StackTraceElement belonging to the caller of the callee. The "best matching" StackTraceElement is considered to be the one not belonging to any "internal" API in a package namespace such as "com.sun.*", "java.*" or "javax.*". The callee can also be a package namespace where the matchee's must begin with the given package namespace.
        Parameters:
        aCalleeClassName - The callee class name or package namespace 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.

      • toBestCallerStackTraceElement

        public static StackTraceElement toBestCallerStackTraceElement​(StackTraceElement aCallee)
        Returns the best matching StackTraceElement belonging to the caller of the callee.The "best matching" StackTraceElement is considered to be the one not belonging to any "internal" API in a package namespace such as "com.sun.*", "java.*" or "javax.*".
        Parameters:
        aCallee - The callee StackTraceElement 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.

      • toBestCallerStackTraceElement

        public static StackTraceElement toBestCallerStackTraceElement​(Class<?> aCallee)
        Returns the best matching StackTraceElement belonging to the caller of the callee.The "best matching" StackTraceElement is considered to be the one not belonging to any "internal" API in a package namespace such as "com.sun.*", "java.*" or "javax.*".
        Parameters:
        aCallee - The callee StackTraceElement 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.

      • toBestCallerStackTraceElement

        public static StackTraceElement toBestCallerStackTraceElement​(String[] aCallees)
        Returns the best matching StackTraceElement belonging to the caller of one of the callees (in the order passed to the method).The "best matching" StackTraceElement is considered to be the one not belonging to any "internal" API in a package namespace such as "com.sun.*", "java.*" or "javax.*". The callees can also be a package namespace where the matchee's must begin with the given package namespace.
        Parameters:
        aCallees - The callees names for which 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.

      • toBestCallerStackTraceElement

        public static StackTraceElement toBestCallerStackTraceElement​(StackTraceElement[] aCallees)
        Returns the best matching StackTraceElement belonging to the caller of one of the callees (in the order passed to the method).The "best matching" StackTraceElement is considered to be the one not belonging to any "internal" API in a package namespace such as "com.sun.*", "java.*" or "javax.*".
        Parameters:
        aCallees - The callees StackTraceElement instances for which 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.

      • toBestCallerStackTraceElement

        public static StackTraceElement toBestCallerStackTraceElement​(Class<?>[] aCallees)
        Returns the best matching StackTraceElement belonging to the caller of one of the callees (in the order passed to the method).The "best matching" StackTraceElement is considered to be the one not belonging to any "internal" API in a package namespace such as "com.sun.*", "java.*" or "javax.*".
        Parameters:
        aCallees - The callees Class instances for which 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.

      • getCallerType

        public static Class<?> getCallerType()
        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.
        Parameters:
        aCallees - the callees
        Returns:
        the caller type

      • getCallerType

        public static Class<?> getCallerType​(StackTraceElement 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​(String... aCallees)
        Same as getCallerType(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.
        Parameters:
        aCallees - the callees
        Returns:
        the caller type

      • getCallerType

        public static Class<?> getCallerType​(String aCallee)
        Returns the type of the (Class) belonging to the caller of the callee. The callee can also be a package namespace where the matchee's must begin with the given package namespace.
        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​(StackTraceElement... aCallees)
        Same as getCallerType(StackTraceElement) with the difference that the passed callees are tried out one after the other until the first caller determined for a callee is returned.
        Parameters:
        aCallees - the callees
        Returns:
        the caller type

      • toFullyQualifiedClassName

        public static String toFullyQualifiedClassName​(StackTraceElement aStackTraceElement)
        Retrieves the fully qualified class name from a StackTraceElement.
        Parameters:
        aStackTraceElement - The StackTraceElement 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 StackTraceElement. This adds the method name to the fully qualified path name separated by a hash "#".
        Parameters:
        aStackTraceElement - The StackTraceElement 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 StackTraceElement.
        Parameters:
        aStackTraceElement - The StackTraceElement 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"
        Type Parameters:
        T - the generic type
        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 TID) PID of the process running your JVM instance.
        Returns:
        The PID (process TID) 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 TID (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 TID (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 - the interrupted exception
        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"

      • toUserWorkingDir

        public static File toUserWorkingDir()
        Tries to determine the current directory from which the Java programm was started for example as of bash's pwd command. Pass as JVM argument via "-Dcurrent.dir=/path/to/current/dir".
        Returns:
        The current path of the user invoking the Java programm or null if the current path cannot be determined.

      • toLauncherDir

        public static File toLauncherDir()
        Generates the base path relative to the given class location. Depending on the runtime, the path is truncated till the required path is determined. In case the SystemProperty.LAUNCHER_DIR (e.g. when providing the following argument -Dlauncher.dir=/path/to/launcher/dir when invoking your java's executable) is set and in case its value points to a directory, then this directory is returned.
        Returns:
        The base path of this application.

      • getMainClass

        public static Class getMainClass()
        Returns the main class launching the application.
        Returns:
        The main class.

      • toProperties

        public static Map<String,​String> toProperties​(String[] aArgs)
        Creates a Map from the provided command line arguments using the CommandArgPrefix.toPrefixes() prefixes to identify the keys (and the values) from the provided arguments.
        Parameters:
        aArgs - The command line arguments to convert to properties.
        Returns:
        The Map containing the determined properties.

      • toProperties

        public static Map<String,​String> toProperties​(String[] aArgs,
                                                    String[] aPrefixes,
                                                    char aDelimiter)
        Creates a Map from the provided command line arguments using the provided prefixes to identify the keys (and the values) from the provided arguments.
        Parameters:
        aArgs - The command line arguments to convert to properties.
        aPrefixes - The prefixes to be used to identify options.
        aDelimiter - The delimiter to use when generating non colliding keys.
        Returns:
        The Map containing the determined properties.

      • addShutdownHook

        public static void addShutdownHook​(Thread hook)
        Registers a new virtual-machine shutdown hook. In case of running as a native image (GraalVM AOT), then a Signal handler for capturing CTRL+C is registered exiting the application regularirly so that shutdown hooks registered with Runtime.addShutdownHook(Thread) are also called when inside a native image. Exiting vie CTRL+C then will exit with status code 130 as of ExitCode.CONTROL_C.
        Parameters:
        hook - An initialized but unstarted Thread object

      • putProperty

        protected static void putProperty​(Map<String,​String> aProperties,
                                  String aKey,
                                  String aValue,
                                  char aDelimiter)
        Puts a property and resolves the key in case of name collisions.
        Parameters:
        aProperties - The properties which to modify.
        aKey - The key which to put.
        aValue - The value to put.
        aDelimiter - The delimiter to use when generating non colliding keys.

      • toNextKey

        protected static String toNextKey​(Map<String,​String> aProperties,
                                  String aKey,
                                  char aDelimiter)
        Returns the next free key in the properties in case of key name collisions..
        Parameters:
        aProperties - The properties for which to determine the next key.
        aKey - The key for which to test for name collisions.
        aDelimiter - The delimiter to use when creating non colliding keys.
        Returns:
        The next non colliding key or null if there are no collisions.

      • toOption

        protected static String toOption​(String aArg,
                                 String... aPrefixes)
        When the provided argument starts with one of the provided prefixes, then the portion of the argument without the prefix is returned, which represents the option in question.
        Parameters:
        aArg - The argument for which to retrieve the option's name.
        aPrefixes - The prefixes to use when determining options.
        Returns:
        Either the option's name or null if the argument does not represent an option.