Package org.eclipse.ui
Interface IMarkerHelpContextProvider
-
public interface IMarkerHelpContextProviderProvides a help context for a given marker.- Since:
- 3.15
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetHelpContextForMarker(IMarker marker)Get the help context for the given marker.booleanhasHelpContextForMarker(IMarker marker)Whether this provider may have a context for the given marker.
-
-
-
Method Detail
-
getHelpContextForMarker
String getHelpContextForMarker(IMarker marker)
Get the help context for the given marker.- Parameters:
marker- The marker to get the help Context for.- Returns:
- The help context for the marker or null if this provider does not have a context for the given marker.
-
hasHelpContextForMarker
boolean hasHelpContextForMarker(IMarker marker)
Whether this provider may have a context for the given marker.If this method returns false, this provider does definitely not have a context for this marker. If this method returns true,
getHelpContextForMarker(IMarker)may still return null.Implementations should consider always returning true, if there is no efficient way to check this.
- Parameters:
marker- The marker to check.- Returns:
- Whether this provider may have a context for the given marker.
-
-