Generalized usage of idealOrdering for coordinates

[aegershman]

Yammering this out, but: I've been thinking about the usage of Comparator when inserting a new annotation on addAnnotation coordinates:

rewrite/rewrite-java/src/main/java/org/openrewrite/java/tree/Coordinates.java

Lines 193 to 195 in d21da2e

	public JavaCoordinates addAnnotation(Comparator<J.Annotation> idealOrdering) {
	return new JavaCoordinates(tree, Space.Location.ANNOTATION_PREFIX, idealOrdering);
	}

I can think of situations where it'd be valuable to add a new field or method decl to a class; could specifying some sort of comparator or ideal insertion ordering help in the general case? As in, if I wanted to insert a new J.MethodDeclaration back into a J.ClassDeclaration body, the easiest way to insert it is using the coordinates of classDeclaration.getBody().getCoordinates().lastStatement(), or finding a way to do before() on any existing Statements in the body (if any exist).

What would, if any, a generalized usage of idealordering look like? If I was inserting a new MethodDeclaration, then nn a ClassDeclaration, could I specify addStatement() as the coordinates, and be able to say "insert this in where Method Declarations should go as first, then alphabetically within method declarations" (or have that be specified by some sort of predefined general style)?

Just putting the thought out there 👍

[jkschneider]

Looking to add a method to ListUtils to generalize this: