Even more javadocs

Author: gzsombor

org.eclipse.jdt.debug.ui/ui/org/eclipse/jdt/internal/debug/ui/JDIDebugUIPreferenceInitializer.java

@@ -20,6 +20,7 @@
 import org.eclipse.jdt.debug.ui.IJavaDebugUIConstants;
 import org.eclipse.jface.preference.IPreferenceStore;
 import org.eclipse.jface.util.PropertyChangeEvent;
+import org.eclipse.jface.util.Util;
 
 public class JDIDebugUIPreferenceInitializer extends AbstractPreferenceInitializer {
 
@@ -47,9 +48,9 @@ public void initializeDefaultPreferences() {
 		store.setDefault(IJDIPreferencesConstants.PREF_STEP_THRU_FILTERS, true);
 
 		store.setDefault(IJDIPreferencesConstants.PREF_ACTIVE_PLATFORM_FRAME_FILTER_LIST, "java.*,javax.*,jdk.*,sun.*,sunw.*,org.junit.*,org.eclipse.jdt.internal.*"); //$NON-NLS-1$
-		store.setDefault(IJDIPreferencesConstants.PREF_INACTIVE_PLATFORM_FRAME_FILTER_LIST, ""); //$NON-NLS-1$
-		store.setDefault(IJDIPreferencesConstants.PREF_ACTIVE_CUSTOM_FRAME_FILTER_LIST, ""); //$NON-NLS-1$
-		store.setDefault(IJDIPreferencesConstants.PREF_INACTIVE_CUSTOM_FRAME_FILTER_LIST, ""); //$NON-NLS-1$
+		store.setDefault(IJDIPreferencesConstants.PREF_INACTIVE_PLATFORM_FRAME_FILTER_LIST, Util.ZERO_LENGTH_STRING);
+		store.setDefault(IJDIPreferencesConstants.PREF_ACTIVE_CUSTOM_FRAME_FILTER_LIST, Util.ZERO_LENGTH_STRING);
+		store.setDefault(IJDIPreferencesConstants.PREF_INACTIVE_CUSTOM_FRAME_FILTER_LIST, Util.ZERO_LENGTH_STRING);
 		store.setDefault(IJDIPreferencesConstants.PREF_COLLAPSE_STACK_FRAMES, true);
 
 		store.setDefault(IDebugUIConstants.ID_VARIABLE_VIEW + "." + IJDIPreferencesConstants.PREF_SHOW_CONSTANTS, false); //$NON-NLS-1$

org.eclipse.jdt.debug.ui/ui/org/eclipse/jdt/internal/debug/ui/StackFramePresentationProvider.java

@@ -137,7 +137,8 @@ private boolean isEnabled(@SuppressWarnings("unused") Category category) {
 	}
 
 	/**
-	 * Visible for testing!
+	 * Categorize the given {@link IJavaStackFrame} into a {@link Category} based on the rules and filters, and where those classes are in the
+	 * project. For example if in a source folder, in a library or in a test source folder, etc.
 	 */
 	public IJavaStackFrame.Category categorize(IJavaStackFrame frame) throws DebugException {
 		var refTypeName = frame.getReferenceType().getName();
@@ -154,6 +155,10 @@ public IJavaStackFrame.Category categorize(IJavaStackFrame frame) throws DebugEx
 		return categorizeSourceElement(frame);
 	}
 
+	/**
+	 * Do the categorization with the help of a {@link org.eclipse.debug.core.model.ISourceLocator} coming from the associated
+	 * {@link org.eclipse.debug.core.ILaunch}. This is how we can find, if the class file is in a jar or comes from a source folder.
+	 */
 	private Category categorizeSourceElement(IJavaStackFrame frame) {
 		var sourceLocator = frame.getLaunch().getSourceLocator();
 		if (sourceLocator == null) {
@@ -180,6 +185,9 @@ private Category categorizeSourceElement(IJavaStackFrame frame) {
 		return Category.UNKNOWN;
 	}
 
+	/**
+	 * Unsubscribes to not receive notifications from the {@link IPreferenceStore}.
+	 */
 	public void close() {
 		store.removePropertyChangeListener(this);
 	}
@@ -196,6 +204,9 @@ public void propertyChange(PropertyChangeEvent event) {
 		}
 	}
 
+	/**
+	 * @return if stack frames should be collapsed.
+	 */
 	public boolean isCollapseStackFrames() {
 		return collapseStackFrames;
 	}

org.eclipse.jdt.debug.ui/ui/org/eclipse/jdt/internal/debug/ui/actions/CollapseStackFramesAction.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2022 Zsombor Gegesy and others.
+ * Copyright (c) 2022, 2025 Zsombor Gegesy and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0

org.eclipse.jdt.debug.ui/ui/org/eclipse/jdt/internal/debug/ui/monitors/JavaThreadContentProvider.java

@@ -71,6 +71,10 @@ protected int getChildCount(Object element, IPresentationContext context, IViewe
 		return childCount;
 	}
 
+	/**
+	 * return the number of child objects for the given {@link IJavaThread}, either the number of frames, or if frame grouping is enabled, the
+	 * {@link GroupedStackFrame}s are properly accounted.
+	 */
 	private int getFrameCount(IJavaThread thread) throws DebugException {
 		if (getStackFrameProvider().isCollapseStackFrames()) {
 			return getStackFrames(thread).size();

org.eclipse.jdt.debug.ui/ui/org/eclipse/jdt/internal/debug/ui/monitors/MonitorsAdapterFactory.java

@@ -40,11 +40,11 @@ public class MonitorsAdapterFactory implements IAdapterFactory {
 	@SuppressWarnings("unchecked")
 	public <T> T getAdapter(Object adaptableObject, Class<T> adapterType) {
 
-    	if (IElementContentProvider.class.equals(adapterType)) {
-			if (adaptableObject instanceof IJavaThread || adaptableObject instanceof GroupedStackFrame) {
-				return (T) getThreadPresentation();
-	        }
-    		if (adaptableObject instanceof IJavaStackFrame) {
+        if (IElementContentProvider.class.equals(adapterType)) {
+            if (adaptableObject instanceof IJavaThread || adaptableObject instanceof GroupedStackFrame) {
+                return (T) getThreadPresentation();
+            }
+            if (adaptableObject instanceof IJavaStackFrame) {
 				return (T) fgCPFrame;
     		}
     		if (adaptableObject instanceof JavaOwnedMonitor) {