Package org.openjdk.jmc.common.util

Class FormatToolkit

  • public class FormatToolkit
extends java.lang.Object
    Methods for formatting IMC* instances.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.lang.String ARRAY  
      private static char CLASS_PREFIX  
      private static char CLASS_SUFFIX  
      private static java.lang.String COMMA_SEPARATOR  
      private static char LB  
      private static char LP  
      private static char PACKAGE_SEPARATOR  
      private static char RP  

    • Constructor Summary

      Constructors 
      Constructor Description
      FormatToolkit()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      private static java.lang.String getClass​(java.lang.String clazz, boolean qualified)  
      static java.lang.String getHumanReadable​(IMCClassLoader classLoader)
      Get a human readable string representing a classloader.
      static java.lang.String getHumanReadable​(IMCMethod method)
      Get a human readable string representing a method, displays all available information
      static java.lang.String getHumanReadable​(IMCMethod method, boolean showReturnValue, boolean showReturnValuePackage, boolean showClassName, boolean showClassPackageName, boolean showArguments, boolean showArgumentsPackage)
      Get a human readable string representing a method.
      static java.lang.String getHumanReadable​(IMCStackTrace trace)
      Get a human readable string representing a stack trace, displays all available information.
      static java.lang.String getHumanReadable​(IMCStackTrace trace, boolean showReturnValue, boolean showReturnValuePackage, boolean showClassName, boolean showClassPackageName, boolean showArguments, boolean showArgumentsPackage, int maximumVisibleStackTraceElements, java.lang.String indent, java.lang.String linePrefix, java.lang.String lineSeparator)
      Get a human readable string representing a stack trace.
      static java.lang.String getHumanReadable​(IMCStackTrace trace, java.lang.String indent, java.lang.String linePrefix, java.lang.String lineSeparator)
      Get a human readable string representing a stack trace, displays all available information.
      static java.lang.String getPackage​(IMCPackage mcPackage)
      Get the package name as a human readable string.
      private static java.lang.String getParameters​(java.lang.String descriptor, boolean qualified)  
      private static java.lang.String getPrimitiveType​(char ch)  
      private static java.lang.String getReturnType​(java.lang.String descriptor, boolean qualified)  
      static java.lang.String getType​(IMCType type, boolean qualified)
      Get the type name as a human readable string.
      private static int parseToken​(java.lang.StringBuffer output, java.lang.String input, int position, boolean qualified)  
      private static int readArray​(java.lang.StringBuffer output, java.lang.String input, int position, boolean qualified)  
      private static int readComponentType​(java.lang.StringBuffer output, java.lang.String input, int position, boolean qualified)  
      private static int readPrimitive​(java.lang.StringBuffer output, java.lang.String input, int position, boolean qualified)  
      private static int write​(java.lang.StringBuffer output, java.lang.String string, int next_position)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • FormatToolkit

        public FormatToolkit()

    • Method Detail

      • getHumanReadable

        public static java.lang.String getHumanReadable​(IMCMethod method)
        Get a human readable string representing a method, displays all available information
        Returns:
        a human readable string representing the method

      • getHumanReadable

        public static java.lang.String getHumanReadable​(IMCMethod method,
                                                boolean showReturnValue,
                                                boolean showReturnValuePackage,
                                                boolean showClassName,
                                                boolean showClassPackageName,
                                                boolean showArguments,
                                                boolean showArgumentsPackage)
        Get a human readable string representing a method.
        Parameters:
        method - the method to get a string for
        showReturnValue - true if the return value type should be included
        showReturnValuePackage - true if the package name of the return value type should be included. Only relevant if showReturnValue is true.
        showClassName - true if the class name for the method should be included
        showClassPackageName - true if the package name of the class for the method should be included. Only relevant if showClassName is true.
        showArguments - true if the class names for the method arguments should be included
        showArgumentsPackage - true if the package names of the classes for the method arguments should be included. Only relevant if showArguments is true.
        Returns:
        a human readable string representing the method

      • getPackage

        public static java.lang.String getPackage​(IMCPackage mcPackage)
        Get the package name as a human readable string. If it is the default package (the empty string), then get a describing text for that.
        Parameters:
        mcPackage - package instance to format
        Returns:
        the package name

      • getType

        public static java.lang.String getType​(IMCType type,
                                       boolean qualified)
        Get the type name as a human readable string.
        Parameters:
        type - type instance to format
        qualified - true if the returned string should be fully qualified
        Returns:
        the type name, fully qualified if requested so

      • getReturnType

        private static java.lang.String getReturnType​(java.lang.String descriptor,
                                              boolean qualified)
                                       throws java.lang.Exception
        Throws:
        java.lang.Exception

      • getParameters

        private static java.lang.String getParameters​(java.lang.String descriptor,
                                              boolean qualified)
                                       throws java.lang.Exception
        Throws:
        java.lang.Exception

      • parseToken

        private static int parseToken​(java.lang.StringBuffer output,
                              java.lang.String input,
                              int position,
                              boolean qualified)
                       throws java.lang.Exception
        Throws:
        java.lang.Exception

      • readArray

        private static int readArray​(java.lang.StringBuffer output,
                             java.lang.String input,
                             int position,
                             boolean qualified)
                      throws java.lang.Exception
        Throws:
        java.lang.Exception

      • readPrimitive

        private static int readPrimitive​(java.lang.StringBuffer output,
                                 java.lang.String input,
                                 int position,
                                 boolean qualified)
                          throws java.lang.Exception
        Throws:
        java.lang.Exception

      • write

        private static int write​(java.lang.StringBuffer output,
                         java.lang.String string,
                         int next_position)

      • readComponentType

        private static int readComponentType​(java.lang.StringBuffer output,
                                     java.lang.String input,
                                     int position,
                                     boolean qualified)

      • getClass

        private static java.lang.String getClass​(java.lang.String clazz,
                                         boolean qualified)

      • getPrimitiveType

        private static java.lang.String getPrimitiveType​(char ch)

      • getHumanReadable

        public static java.lang.String getHumanReadable​(IMCStackTrace trace)
        Get a human readable string representing a stack trace, displays all available information.
        Parameters:
        trace - the stack trace to get a string for
        Returns:
        a human readable string representing the stack trace

      • getHumanReadable

        public static java.lang.String getHumanReadable​(IMCStackTrace trace,
                                                java.lang.String indent,
                                                java.lang.String linePrefix,
                                                java.lang.String lineSeparator)
        Get a human readable string representing a stack trace, displays all available information.
        Parameters:
        trace - the stack trace to get a string for
        indent - string to use for indentation, defaults to four spaces if parameter is null
        linePrefix - string to use as a line prefix, defaults to "at " if parameter is null string to use for indentation
        lineSeparator - string to use as line separator, defaults to line separator property if parameter is null
        Returns:
        a human readable string representing the stack trace

      • getHumanReadable

        public static java.lang.String getHumanReadable​(IMCStackTrace trace,
                                                boolean showReturnValue,
                                                boolean showReturnValuePackage,
                                                boolean showClassName,
                                                boolean showClassPackageName,
                                                boolean showArguments,
                                                boolean showArgumentsPackage,
                                                int maximumVisibleStackTraceElements,
                                                java.lang.String indent,
                                                java.lang.String linePrefix,
                                                java.lang.String lineSeparator)
        Get a human readable string representing a stack trace.
        Parameters:
        trace - the stack trace to get a string for
        showReturnValue - true if the return value type should be included
        showReturnValuePackage - true if the package name of the return value type should be included. Only relevant if showReturnValue is true.
        showClassName - true if the class name for the method should be included
        showClassPackageName - true if the package name of the class for the method should be included. Only relevant if showClassName is true.
        showArguments - true if the class names for the method arguments should be included
        showArgumentsPackage - true if the package names of the classes for the method arguments should be included. Only relevant if showArguments is true.
        indent - string to use for indentation, defaults to four spaces if parameter is null
        linePrefix - string to use as a line prefix, defaults to "at " if parameter is null string to use for indentation
        lineSeparator - string to use as line separator, defaults to line separator property if parameter is null
        Returns:
        a human readable string representing the stack trace

      • getHumanReadable

        public static java.lang.String getHumanReadable​(IMCClassLoader classLoader)
        Get a human readable string representing a classloader.
        Parameters:
        classLoader - the classloader to get a string for
        Returns:
        a human readable string representing the classloader