5603: Version specific help links in event type missing result

Reviewed-by: hirt

Author: jpbempel

core/org.openjdk.jmc.flightrecorder.rules/src/main/java/org/openjdk/jmc/flightrecorder/rules/util/RulesToolkit.java

@@ -533,22 +533,28 @@ private static boolean hasEvents(IItemCollection items, String ... typeIds) {
 	 */
 	public static Result getEventAvailabilityResult(
 		IRule rule, IItemCollection items, EventAvailability eventAvailability, String ... typeIds) {
+		JavaVersion javaVersion;
+		String link;
 		switch (eventAvailability) {
 		case ENABLED:
 		case NONE:
 			String requiredEventsTypeNames = getEventTypeNames(items, typeIds);
+			javaVersion = RulesToolkit.getJavaSpecVersion(items);
+			link = RulesToolkit.getJavaCommandHelpLink(javaVersion);
 			return getNotApplicableResult(rule,
 					MessageFormat.format(Messages.getString(Messages.RulesToolkit_RULE_REQUIRES_EVENTS),
 							requiredEventsTypeNames),
 					MessageFormat.format(Messages.getString(Messages.RulesToolkit_RULE_REQUIRES_EVENTS_LONG),
-							rule.getName(), requiredEventsTypeNames));
+							rule.getName(), requiredEventsTypeNames, link));
 		case DISABLED:
 			String disabledEventTypeNames = getDisabledEventTypeNames(items, typeIds);
+			javaVersion = RulesToolkit.getJavaSpecVersion(items);
+			link = RulesToolkit.getJavaCommandHelpLink(javaVersion);
 			return getNotApplicableResult(rule,
 					MessageFormat.format(Messages.getString(Messages.RulesToolkit_RULE_REQUIRES_EVENT_TYPE),
 							disabledEventTypeNames),
 					MessageFormat.format(Messages.getString(Messages.RulesToolkit_RULE_REQUIRES_EVENT_TYPE_LONG),
-							rule.getName(), disabledEventTypeNames));
+							rule.getName(), disabledEventTypeNames, link));
 		case UNKNOWN:
 			// Can't get type names if the event type is unavailable
 			List<String> quotedTypeIds = new ArrayList<>();
@@ -565,12 +571,14 @@ public static Result getEventAvailabilityResult(
 							rule.getName(), unavailableTypeNames));
 		case AVAILABLE:
 			String availableEventTypeNames = getEventTypeNames(items, typeIds);
+			javaVersion = RulesToolkit.getJavaSpecVersion(items);
+			link = RulesToolkit.getJavaCommandHelpLink(javaVersion);
 			return getNotApplicableResult(rule,
 					MessageFormat.format(
 							Messages.getString(Messages.RulesToolkit_RULE_REQUIRES_EVENT_TYPE_NOT_AVAILABLE),
 							availableEventTypeNames),
 					MessageFormat.format(Messages.RulesToolkit_RULE_REQUIRES_EVENT_TYPE_NOT_AVAILABLE_LONG,
-							rule.getName(), availableEventTypeNames));
+							rule.getName(), availableEventTypeNames, link));
 		default:
 			throw new IllegalArgumentException("Unsupported event availability: " + eventAvailability); //$NON-NLS-1$
 		}
@@ -1008,6 +1016,29 @@ public static JavaVersion getJavaVersion(String vmInfoVersionString) {
 		return null;
 	}
 
+	static String getJavaCommandHelpLink(JavaVersion javaVersion) {
+		if (javaVersion != null) {
+			int major = javaVersion.getMajorVersion();
+			switch (major) {
+			case 8:
+				return "https://docs.oracle.com/javase/8/docs/technotes/tools/unix/java.html"; //$NON-NLS-1$
+			case 9:
+			case 10:
+				return "https://docs.oracle.com/javase/" + major + "/tools/java.htm#JSWOR624";
+			case 11:
+			case 12:
+				return "https://docs.oracle.com/en/java/javase/" + major
+						+ "/tools/java.html#GUID-3B1CE181-CD30-4178-9602-230B800D4FAE";
+			case 13:
+			case 14:
+			case 15:
+				return "https://docs.oracle.com/en/java/javase/" + major + "/docs/specs/man/java.html";
+			}
+		}
+		// by default use version 8
+		return "https://docs.oracle.com/javase/8/docs/technotes/tools/unix/java.html"; //$NON-NLS-1$
+	}
+
 	/**
 	 * Gets the {@link IType} representation of a specific event type in an {@link IItemCollection}.
 	 *

core/org.openjdk.jmc.flightrecorder.rules/src/main/resources/org/openjdk/jmc/flightrecorder/rules/messages/internal/messages.properties

@@ -41,16 +41,16 @@ RulesToolkit_RULE_REQUIRES_UNAVAILABLE_EVENT_TYPE=The {0} rule requires the foll
 RulesToolkit_RULE_REQUIRES_UNAVAILABLE_EVENT_TYPE_LONG=The {0} rule requires the following event types: {1}.<p>They are either not available in this version of Java, or must be enabled in a third-party component. If you are using an older Java version, then you can consider upgrading.
 # {0} is an event type name
 RulesToolkit_RULE_REQUIRES_EVENT_TYPE_NOT_AVAILABLE=This rule requires that there are no events from the following types: {0}.
-# {0} is a rule name, {1} is one or more event type names
-RulesToolkit_RULE_REQUIRES_EVENT_TYPE_NOT_AVAILABLE_LONG=The {0} rule requires that there are no events from the following types: {1}.<p>Please disable the event types for this rule to work. If you are using JMC to create a flight recording, then you can disable event types in the Start Flight Recording wizard. If you are starting the flight recording from the command line, then you can use the settings parameter of <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/java.html">-XX:FlightRecorderOptions</a>.
+# {0} is a rule name, {1} is one or more event type names, {2} is a link to java command help
+RulesToolkit_RULE_REQUIRES_EVENT_TYPE_NOT_AVAILABLE_LONG=The {0} rule requires that there are no events from the following types: {1}.<p>Please disable the event types for this rule to work. If you are using JMC to create a flight recording, then you can disable event types in the Start Flight Recording wizard. If you are starting the flight recording from the command line, then you can use the settings parameter of <a href="{2}">-XX:FlightRecorderOptions</a>.
 # {0} is an event type name
 RulesToolkit_RULE_REQUIRES_EVENTS=This rule requires events to be available from the following event types: {0}.
-# {0} is a rule name, {1} is one or more event type names
-RulesToolkit_RULE_REQUIRES_EVENTS_LONG=The {0} rule requires events to be available from the following event types: {1}.<p>They were either disabled during the recording or there might not have happened anything to trigger an event. Event settings like period and threshold may also prevent some events from being emitted. If you are using JMC to create a flight recording, then you can enable and configure event types in the Start Flight Recording wizard. If you are starting the flight recording from the command line, then you can use the settings parameter of <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/java.html">-XX:FlightRecorderOptions</a>.
+# {0} is a rule name, {1} is one or more event type names, {2} is a link to java command help
+RulesToolkit_RULE_REQUIRES_EVENTS_LONG=The {0} rule requires events to be available from the following event types: {1}.<p>They were either disabled during the recording or there might not have happened anything to trigger an event. Event settings like period and threshold may also prevent some events from being emitted. If you are using JMC to create a flight recording, then you can enable and configure event types in the Start Flight Recording wizard. If you are starting the flight recording from the command line, then you can use the settings parameter of <a href="{2}">-XX:FlightRecorderOptions</a>.
 # {0} is an event type name
 RulesToolkit_RULE_REQUIRES_EVENT_TYPE=This rule requires that the following event types are enabled: {0}.
 # {0} is a rule name, {1} is one or more event type names
-RulesToolkit_RULE_REQUIRES_EVENT_TYPE_LONG=The {0} rule requires that the following event types are enabled: {1}.<p>If you are using JMC to create a flight recording, then you can enable event types in the Start Flight Recording wizard. If you are starting the flight recording from the command line, then you can use the settings parameter of <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/unix/java.html">-XX:FlightRecorderOptions</a>.
+RulesToolkit_RULE_REQUIRES_EVENT_TYPE_LONG=The {0} rule requires that the following event types are enabled: {1}.<p>If you are using JMC to create a flight recording, then you can enable event types in the Start Flight Recording wizard. If you are starting the flight recording from the command line, then you can use the settings parameter of <a href="{2}">-XX:FlightRecorderOptions</a>.
 # {0} is a rule name, {1} is one or more event type names
 RulesToolkit_RULE_REQUIRES_SOME_EVENTS=The {0} rule requires events to be available from at least one of the following event types: {1}.
 # {0} is one or more event type names