Customize views
During a debugging session, you get information about your variables, classes, threads, frames, and so on. Depending on your project, you may want to see different details or view the data in different formats. For this, IntelliJ IDEA provides a range of options that allow you to customize how the data appears in the debugger.
There is a set of the most common options, which are always at hand and require no special setup. These options cover most cases. At the same time, you can create a powerful and granular configuration which ensures all of your classes are displayed exactly as you want them to. The degree to which the display format can be customized has virtually no limitations as IntelliJ IDEA lets you write your own code for rendering data.
Customize threads view
You can customize how threads are displayed on the Frames and Threads tabs. It might be helpful when you are working on a multithreaded application and often need to access information about your threads.
Right-click anywhere in the Frames or Threads tab and select Customize Threads View.
| Item | Description |
|---|---|
| Show thread groups | If this option is selected, threads appear in a hierarchy of thread groups. Having a tree-like hierarchy is useful when your program manages a number of similar threads in groups. Also, the option separates system threads from the user-defined ones, making it easier to navigate in the list. In order for a thread to appear in a particular group, use |
| Show stack frames for synthetic methods | Specify whether you want to see stack frames for synthetic methods (the methods introduced by the compiler, which are not present in the source code). An example of such method is a method created by an inner class so that the enclosing class could access its private members. |
| Move current thread to the top | Keeps the current thread on top of the list (when Show thread groups is disabled). |
| Show line number | Shows the number of the line that is currently executed in a frame. This feature requires that the application is compiled with line number information. |
| Show class name | Shows the name of the class containing the method. When the code inside an anonymous inner class is executed, the name of the enclosing class is displayed instead, followed by a dollar sign and a number, for example: Keeping this option enabled is useful when you are dealing with inherited methods and there is a need to quickly differentiate between method implementations in subclasses. |
| Show package name | Shows the name of the package for classes. The code in the default package is not marked. This option is only active when Show class name is enabled. Use it when there is ambiguity that class name alone does not eliminate (like java.util.Date vs. java.sql.Date ). |
| Show source file name | Shows the name of the source file for classes. |
| Show method arguments types | Shows the types of the arguments that a method takes. This is useful when dealing with overloaded versions of the same method. |
Customize data view
IntelliJ IDEA allows you to configure which information about the variables you want to get. For example, you may choose to show/hide instance IDs or use the toString representation for viewing particular sets of classes. These preferences apply to all the places where the variable values are displayed (the Variables tab, inline values view, tooltips, and so on).
Show/hide object types
You can select whether to display the type of the object for the corresponding reference-type variables.
Right-click anywhere in the Variables tab and turn Show types on/off.
The displayed type is the type of the actual object and not the type of the variable that holds the reference. If you want to toggle the visibility of the declared type, use the Declared type option in the Customize Data Views dialog.
Configure display of specific types
You can fine-tune how particular types are displayed.
The procedure and properties described here allow you to configure the basic built-in options that provide for the most cases. For custom configuration, see type renderers.
Right-click anywhere in the Variables tab and select Customize Data Views.
| Item | Description |
|---|---|
| Autoscroll to new local variables | Automatically scrolls to new variables that appear in the scope when stepping. |
| Predict condition values and exceptions based on data flow analysis. | Enables editor hints for boolean expressions or exceptions that are known beforehand based on information from data flow analysis. For more details, see Inline variables view. |
| Show |
|
| Show type for strings | Shows type for java.lang.String instances. When disabled, this type can be identified by the enclosing double quotes. |
| Show hex value for primitives | Adds hexadecimal format for byte, short, int, long, and char types. When enabled, both decimal and hexadecimal formats are shown. |
| Hide null elements in arrays and collections | Excludes null references when displaying the contents of arrays and classes that implement Collection (not applicable to descendants of Map ). |
| Auto populate Throwable object's stack trace | When the program is suspended after throwing an exception or error, its stack trace doesn't have any elements in it yet. For the stack trace to be populated, you have to call getStackTrace() on this Throwable. When Auto populate Throwable object's stack trace is enabled, IntelliJ IDEA does this for you. |
| Enable alternative view for Collection classes | Select this option to display contents of classes that implement Collection, Map, or List in a more convenient format (for example, to display each map entry as a key-value pair). |
| Enable toString() object view | Allows you to configure which classes use the result of
|
Custom type renderers
IntelliJ IDEA allows you to provide a completely custom display format for various objects during a debugging session. This is done using renderers. A renderer is a special setup associated with a particular type that controls how the instances of this type are displayed in the debugger. This setup is based on custom expressions that provide high level of flexibility for displaying the data.
Renderers support all types including primitives and arrays. Also, renderers disregard all access modifiers, so you can access any field irrespective of whether it is encapsulated.
In renderers, you can implement any transformations including sorting and reduction to produce the desired output. You can even utilize sun.misc.Unsafe to display the actual memory addresses during debugging (although this is not recommended).
Renderers are particularly useful when you are working with custom collections, whose contents aren't easily readable, and you need to identify their contents at a glance.
Add a renderer
Right-click anywhere in the Variables tab and select Customize data views.
On the Java type renderers tab, click Add Alt+Insert and configure the newly created renderer as required.
Renderer properties
| Item | Description |
|---|---|
| Renderer name | The name of the renderer. This name is used for managing renderers and doesn't affect how actual data is displayed. |
| Apply renderer to objects of type (fully-qualified name) | The object type to which this renderer applies. Enter the fully qualified name of the class or click Browse If the class uses generics, use raw types for them. Due to type erasure, the types inside the diamond operator have no effect in renderers. |
| When rendering a node | This option determines how an object itself is displayed:
|
| When expanding a node | This option determines how the contents of an object are displayed when it is expanded.
|
| Append default children | Controls whether the fields of the object (that would be normally displayed when no renderer is specified) should appear along with the expression results. This option is only available with Use list of expressions. |
and choose the desired type from the list.Remove a renderer
Right-click anywhere in the Variables tab and select Customize data views.
On the Java type renderers tab, select the renderer that you are going to remove and click Remove Delete.
Mute renderers
You can temporarily disable renderers without removing them altogether:
To mute a single renderer, right-click anywhere in the Variables tab and select Customize data views. On the Java type renderers tab, clear the box against the renderer you are going to mute.
To mute all renderers, right-click anywhere in the Variables tab and select Mute Renderers.
When required, you can unmute the renderers using the same procedure.
Add a renderer using annotation
You can assign type renderers to your classes using IntelliJ IDEA's built-in annotations. While this approach doesn't provide centralized control over the renderers, it is very useful when you need to share them with your team members. Once configured, the renderer will apply to the class (and its subclasses) every time you debug the code that is using them.
On the line preceding the class declaration, add the
@Rendererannotation, for example:import org.jetbrains.annotations.Debug.Renderer; @Renderer(text = "name", childrenArray = "courses.toArray()", hasChildren = "courses.isEmpty()") public class Student { private String name; private ArrayList courses; Student(String name, ArrayList courses){ this.name=name; this.courses=courses; } }
| text() | Specifies the expression for displaying the rendered object. |
| childrenArray() | Specifies the expression for displaying the children of the rendered object. The return value of the expression has to be an array. |
| hasChildren() | Specifies the expression for checking whether the node should be expandable. |
Productivity tips
- Use renderers in big projects
While creating your own renderers takes some time, it will pay back if you are working with a big project where you spend a lot of time working with custom classes.
- Implement sorting in renderers
The expression used for displaying node children returns an array. Since arrays are ordered, this allows you to implement sorting for otherwise unordered structures like
HashMap. This is useful, for example, when you have a map of users and would like to view them sorted by email address.