Package org.openjdk.jmc.common.util
Class FormatToolkit
- java.lang.Object
-
- org.openjdk.jmc.common.util.FormatToolkit
-
public class FormatToolkit extends Object
Methods for formatting IMC* instances.
-
-
Constructor Summary
Constructors Constructor Description FormatToolkit()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static String
getHumanReadable(IMCClassLoader classLoader)
Get a human readable string representing a classloader.static String
getHumanReadable(IMCMethod method)
Get a human readable string representing a method, displays all available informationstatic 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 String
getHumanReadable(IMCMethod method, boolean showReturnValue, boolean showReturnValuePackage, boolean showClassName, boolean showClassPackageName, boolean showArguments, boolean showArgumentsPackage, boolean showModifiers)
Get a human readable string representing a method.static String
getHumanReadable(IMCStackTrace trace)
Get a human readable string representing a stack trace, displays all available information.static String
getHumanReadable(IMCStackTrace trace, boolean showReturnValue, boolean showReturnValuePackage, boolean showClassName, boolean showClassPackageName, boolean showArguments, boolean showArgumentsPackage, int maximumVisibleStackTraceElements, String indent, String linePrefix, String lineSeparator)
Get a human readable string representing a stack trace.static String
getHumanReadable(IMCStackTrace trace, String indent, String linePrefix, String lineSeparator)
Get a human readable string representing a stack trace, displays all available information.static String
getPackage(IMCPackage mcPackage)
Get the package name as a human readable string.static String
getType(IMCType type, boolean qualified)
Get the type name as a human readable string.
-
-
-
Method Detail
-
getHumanReadable
public static 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 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 forshowReturnValue
-true
if the return value type should be includedshowReturnValuePackage
-true
if the package name of the return value type should be included. Only relevant ifshowReturnValue
istrue
.showClassName
-true
if the class name for the method should be includedshowClassPackageName
-true
if the package name of the class for the method should be included. Only relevant ifshowClassName
istrue
.showArguments
-true
if the class names for the method arguments should be includedshowArgumentsPackage
-true
if the package names of the classes for the method arguments should be included. Only relevant ifshowArguments
istrue
.- Returns:
- a human readable string representing the method
-
getHumanReadable
public static String getHumanReadable(IMCMethod method, boolean showReturnValue, boolean showReturnValuePackage, boolean showClassName, boolean showClassPackageName, boolean showArguments, boolean showArgumentsPackage, boolean showModifiers)
Get a human readable string representing a method.- Parameters:
method
- the method to get a string forshowReturnValue
-true
if the return value type should be includedshowReturnValuePackage
-true
if the package name of the return value type should be included. Only relevant ifshowReturnValue
istrue
.showClassName
-true
if the class name for the method should be includedshowClassPackageName
-true
if the package name of the class for the method should be included. Only relevant ifshowClassName
istrue
.showArguments
-true
if the class names for the method arguments should be includedshowArgumentsPackage
-true
if the package names of the classes for the method arguments should be included. Only relevant ifshowArguments
istrue
.showModifiers
-true
if the modifiers for the method should be included. Only relevant ifshowModifiers
istrue
.- Returns:
- a human readable string representing the method
-
getPackage
public static 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 String getType(IMCType type, boolean qualified)
Get the type name as a human readable string.- Parameters:
type
- type instance to formatqualified
-true
if the returned string should be fully qualified- Returns:
- the type name, fully qualified if requested so
-
getHumanReadable
public static 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 String getHumanReadable(IMCStackTrace trace, String indent, String linePrefix, String lineSeparator)
Get a human readable string representing a stack trace, displays all available information.- Parameters:
trace
- the stack trace to get a string forindent
- string to use for indentation, defaults to four spaces if parameter is nulllinePrefix
- string to use as a line prefix, defaults to "at " if parameter is null string to use for indentationlineSeparator
- 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 String getHumanReadable(IMCStackTrace trace, boolean showReturnValue, boolean showReturnValuePackage, boolean showClassName, boolean showClassPackageName, boolean showArguments, boolean showArgumentsPackage, int maximumVisibleStackTraceElements, String indent, String linePrefix, String lineSeparator)
Get a human readable string representing a stack trace.- Parameters:
trace
- the stack trace to get a string forshowReturnValue
-true
if the return value type should be includedshowReturnValuePackage
-true
if the package name of the return value type should be included. Only relevant ifshowReturnValue
istrue
.showClassName
-true
if the class name for the method should be includedshowClassPackageName
-true
if the package name of the class for the method should be included. Only relevant ifshowClassName
istrue
.showArguments
-true
if the class names for the method arguments should be includedshowArgumentsPackage
-true
if the package names of the classes for the method arguments should be included. Only relevant ifshowArguments
istrue
.indent
- string to use for indentation, defaults to four spaces if parameter is nulllinePrefix
- string to use as a line prefix, defaults to "at " if parameter is null string to use for indentationlineSeparator
- 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 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
-
-