GH-89 Introducing %pid and %PID parameters for visualvm.display.name

Author: jisedlac

visualvm/application/nbproject/project.xml

@@ -12,7 +12,7 @@
                     <compile-dependency/>
                     <run-dependency>
                         <release-version>0</release-version>
-                        <specification-version>1.5</specification-version>
+                        <specification-version>1.7</specification-version>
                     </run-dependency>
                 </dependency>
                 <dependency>

visualvm/application/src/org/graalvm/visualvm/application/ApplicationDescriptor.java

@@ -43,7 +43,11 @@
 public class ApplicationDescriptor extends DataSourceDescriptor<Application> {
 
     private static final String DISPLAY_NAME_PROPERTY = "-Dvisualvm.display.name="; // NOI18N
-     
+    
+    private static final String pid_PARAM = "%pid"; // NOI18N
+    private static final String PID_PARAM = "%PID"; // NOI18N
+    
+    
     private String name;
 
     /**
@@ -88,7 +92,7 @@ public void propertyChange(PropertyChangeEvent evt) {
                     } else {
                         // Descriptor doesn't support renaming, set name for overriden getName()
                         String oldName = name;
-                        name = createGenericName(application, type.getName());
+                        name = formatName(createGenericName(application, type.getName()));
                         PropertyChangeSupport pcs = ApplicationDescriptor.this.getChangeSupport();
                         pcs.firePropertyChange(PROPERTY_NAME, oldName, name);
                     }
@@ -152,6 +156,21 @@ private static String resolveCustomName(Application application) {
         return null;
     }
 
+    protected String formatName(String namePattern) {
+        if (namePattern == null) return null;
+        
+        String formatted = namePattern;
+        
+        Integer pid = namePattern.contains(pid_PARAM) || namePattern.contains(PID_PARAM) ? getDataSource().getPid() : null;
+        if (pid != null) {
+            boolean unknownPid = Application.UNKNOWN_PID == pid;
+            formatted = formatted.replace(pid_PARAM, unknownPid ? "unknown" : pid.toString()); // NOI18N
+            formatted = formatted.replace(PID_PARAM, unknownPid ? " (unknown pid) " : " (pid " + pid.toString() + ") ").trim(); // NOI18N
+        }
+        
+        return formatted;
+    }
+    
     private static String createGenericName(Application application, String nameBase) {
         int pid = application.getPid();
         String id = Application.CURRENT_APPLICATION.getPid() == pid ||

visualvm/core/src/org/graalvm/visualvm/core/datasource/descriptor/DataSourceDescriptor.java

@@ -123,7 +123,7 @@ public DataSourceDescriptor(X ds, String n, String desc, Image ic, int pos, int
 
         dataSource = ds;
         changeSupport = new PropertyChangeSupport(dataSource);
-        name = n;
+        name = formatName(n); // NOTE: called after dataSource is set, should work fine in subclasses with overriden formatName()
         description = desc;
         icon = ic;
         preferredPosition = pos;
@@ -158,9 +158,9 @@ public void setName(String newName) {
         if (!supportsRename()) throw new UnsupportedOperationException("Rename not supported for this descriptor"); // NOI18N
         if (newName == null) throw new IllegalArgumentException("Name cannot be null"); // NOI18N
         String oldName = name;
-        name = newName;
+        name = formatName(newName);
         getDataSource().getStorage().setCustomProperties(new String[] { PROPERTY_NAME }, new String[] { newName });
-        getChangeSupport().firePropertyChange(PROPERTY_NAME, oldName, newName);
+        getChangeSupport().firePropertyChange(PROPERTY_NAME, oldName, name);
     }
 
     /**
@@ -172,6 +172,18 @@ public String getName() {
         return name;
     }
 
+    /**
+     * Enables subclasses to process (format) the provided name of the DataSource.
+     * 
+     * @param namePattern name of the DataSource to be processed (formatted)
+     * @return processed (formatted) name of the DataSource.
+     * 
+     * @since VisualVM 1.4.3
+     */
+    protected String formatName(String namePattern) {
+        return namePattern;
+    }
+    
     /**
      * Returns description of the DataSource.
      *