Smaller code and API cleanup for BreakpointTypeCategory

See #1962

Author: iloveeclipse

debug/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/BreakpointEnablement.java

@@ -23,18 +23,23 @@
 import org.eclipse.debug.ui.BreakpointTypeCategory;
 
 /**
- * Breakpoint organizers for breakpoint types.
- *
- * @since 3.1
+ * Breakpoint organizers for breakpoint types based on breakpoint enablement
+ * state.
  */
 public class BreakpointEnablement extends AbstractBreakpointOrganizerDelegate implements IBreakpointListener {
-	private final BreakpointTypeCategory ENABLED = new BreakpointTypeCategory("Enabled", true, 0); //$NON-NLS-1$
-	private final BreakpointTypeCategory DISABLED = new BreakpointTypeCategory("Disabled", true, 1); //$NON-NLS-1$
+
+	private final BreakpointTypeCategory ENABLED = new BreakpointTypeCategory("Enabled", 0); //$NON-NLS-1$
+	private final BreakpointTypeCategory DISABLED = new BreakpointTypeCategory("Disabled", 1); //$NON-NLS-1$
 
 	public BreakpointEnablement() {
 		DebugPlugin.getDefault().getBreakpointManager().addBreakpointListener(this);
 	}
 
+	@Override
+	public void dispose() {
+		DebugPlugin.getDefault().getBreakpointManager().removeBreakpointListener(this);
+	}
+
 	@Override
 	public IAdaptable[] getCategories(IBreakpoint breakpoint) {
 		try {
@@ -51,12 +56,6 @@ public IAdaptable[] getCategories(IBreakpoint breakpoint) {
 		return null;
 	}
 
-	@Override
-	public void dispose() {
-		DebugPlugin.getDefault().getBreakpointManager().removeBreakpointListener(this);
-	}
-
-
 	@Override
 	public void breakpointAdded(IBreakpoint breakpoint) {
 	}

debug/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/views/breakpoints/ElementComparator.java

@@ -75,9 +75,9 @@ private int doCompare(IBreakpointContainer c1, IBreakpointContainer c2) {
 			return -1;
 		}
 
-		if (c1.getCategory() instanceof BreakpointTypeCategory breakType1 && breakType1.hasSortOrder()) {
-			if (c2.getCategory() instanceof BreakpointTypeCategory breakType2 && breakType2.hasSortOrder() ) {
-				return Integer.compare(breakType1.getOrder(), breakType2.getOrder());
+		if (c1.getCategory() instanceof BreakpointTypeCategory breakType1 && breakType1.isSortable()) {
+			if (c2.getCategory() instanceof BreakpointTypeCategory breakType2 && breakType2.isSortable()) {
+				return Integer.compare(breakType1.getSortPriority(), breakType2.getSortPriority());
 			}
 		}
 

debug/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/BreakpointTypeCategory.java

@@ -31,8 +31,8 @@ public class BreakpointTypeCategory extends PlatformObject implements IBreakpoin
 
 	private final String fName;
 	private ImageDescriptor fImageDescriptor = DebugPluginImages.getImageDescriptor(IInternalDebugUIConstants.IMG_OBJS_BREAKPOINT_TYPE);
-	private boolean fSortOrder;
-	private int fOrder;
+	private boolean fSortable;
+	private int fSortPriority;
 	/**
 	 * Constructs a type category for the given type name.
 	 *
@@ -57,18 +57,17 @@ public BreakpointTypeCategory(String name, ImageDescriptor descriptor) {
 	}
 
 	/**
-	 * Constructs a type category for the given type name with the given attributes
-	 * for sorting order.
+	 * Constructs a type category for the given type name with the given sort
+	 * priority.
 	 *
-	 * @param name      breakpoint type name
-	 * @param sortOrder to sort order or not
-	 * @param order     order of the group
+	 * @param name         breakpoint type name
+	 * @param sortPriority used to calculate the sort order of this category
 	 * @since 3.19
 	 */
-	public BreakpointTypeCategory(String name, boolean sortOrder, int order) {
+	public BreakpointTypeCategory(String name, int sortPriority) {
 		fName = name;
-		fSortOrder = sortOrder;
-		fOrder = order;
+		fSortable = true;
+		fSortPriority = sortPriority;
 	}
 
 	/**
@@ -81,14 +80,15 @@ protected String getName() {
 	}
 
 	/**
-	 * Returns the order of this category's placement.
+	 * Returns the sorting priority of this category.
 	 *
-	 * @return the order of this category's placement.
+	 * @return the sorting priority of this category, default is {@code 0}
 	 * @since 3.19
 	 */
-	public int getOrder() {
-		return fOrder;
+	public int getSortPriority() {
+		return fSortPriority;
 	}
+
 	@Override
 	public boolean equals(Object object) {
 		if (object instanceof BreakpointTypeCategory type) {
@@ -98,13 +98,13 @@ public boolean equals(Object object) {
 	}
 
 	/**
-	 * Returns whether category should follow a sorting order or not.
+	 * Returns whether category has some sort order or not.
 	 *
-	 * @return whether category should be sorted or not.
+	 * @return whether category can be sorted or not.
 	 * @since 3.19
 	 */
-	public boolean hasSortOrder() {
-		return fSortOrder;
+	public boolean isSortable() {
+		return fSortable;
 	}
 
 	@Override