Apply spotless and document origin

Author: arouel

lib-extra/src/jdt/java/com/diffplug/spotless/extra/glue/jdt/DefaultJavaElementComparator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -38,10 +38,10 @@ public class EclipseJdtFormatterStepImpl {
 
 	public EclipseJdtFormatterStepImpl(Properties formatterSettings, Map<String, String> sortProperties) {
 		Map<String, String> options = formatterSettings.entrySet().stream().collect(Collectors.toMap(
-			e -> String.valueOf(e.getKey()),
-			e -> String.valueOf(e.getValue()),
-			(prev, next) -> next,
-			HashMap::new));
+				e -> String.valueOf(e.getKey()),
+				e -> String.valueOf(e.getValue()),
+				(prev, next) -> next,
+				HashMap::new));
 		this.codeFormatter = new DefaultCodeFormatter(options);
 		this.sortProperties = EclipseJdtSortMembers.SortProperties.from(sortProperties);
 	}

lib-extra/src/jdt/java/com/diffplug/spotless/extra/glue/jdt/EclipseJdtFormatterStepImpl.java

@@ -1,3 +1,18 @@
+/*
+ * Copyright 2024 DiffPlug
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package com.diffplug.spotless.extra.glue.jdt;
 
 import java.util.Comparator;
@@ -58,10 +73,10 @@ static String sortMember(String code, SortProperties properties) {
 		try {
 			CompilationUnit compilationUnit = compilationUnit(code);
 			DefaultJavaElementComparator comparator = DefaultJavaElementComparator.of(
-				properties.doNotSortFields,
-				properties.membersOrder,
-				properties.sortByVisibility,
-				properties.visibilityOrder);
+					properties.doNotSortFields,
+					properties.membersOrder,
+					properties.sortByVisibility,
+					properties.visibilityOrder);
 			new Sorter(AST.getJLSLatest(), compilationUnit, null, comparator).sort();
 			String content = compilationUnit.getBuffer().getContents();
 			if (content != null) {
@@ -81,17 +96,13 @@ private static class Buffer implements IBuffer {
 			this.contents = contents;
 		}
 
-		public void addBufferChangedListener(IBufferChangedListener listener) {
-		}
+		public void addBufferChangedListener(IBufferChangedListener listener) {}
 
-		public void append(char[] text) {
-		}
+		public void append(char[] text) {}
 
-		public void append(String text) {
-		}
+		public void append(String text) {}
 
-		public void close() {
-		}
+		public void close() {}
 
 		public char getChar(int position) {
 			return '\u0000';
@@ -133,20 +144,15 @@ public boolean isReadOnly() {
 			return true;
 		}
 
-		public void removeBufferChangedListener(IBufferChangedListener listener) {
-		}
+		public void removeBufferChangedListener(IBufferChangedListener listener) {}
 
-		public void replace(int position, int length, char[] text) {
-		}
+		public void replace(int position, int length, char[] text) {}
 
-		public void replace(int position, int length, String text) {
-		}
+		public void replace(int position, int length, String text) {}
 
-		public void save(IProgressMonitor progress, boolean force) {
-		}
+		public void save(IProgressMonitor progress, boolean force) {}
 
-		public void setContents(char[] contents) {
-		}
+		public void setContents(char[] contents) {}
 
 		public void setContents(String contents) {
 			this.contents = contents;
@@ -172,12 +178,11 @@ static class SortProperties {
 		final String visibilityOrder;
 
 		SortProperties(
-			boolean enabled,
-			String membersOrder,
-			boolean doNotSortFields,
-			boolean sortByVisibility,
-			String visibilityOrder
-		) {
+				boolean enabled,
+				String membersOrder,
+				boolean doNotSortFields,
+				boolean sortByVisibility,
+				String visibilityOrder) {
 			this.enabled = enabled;
 			this.membersOrder = membersOrder;
 			this.doNotSortFields = doNotSortFields;

lib-extra/src/jdt/java/com/diffplug/spotless/extra/glue/jdt/EclipseJdtSortMembers.java

@@ -1,3 +1,18 @@
+/*
+ * Copyright 2024 DiffPlug
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package com.diffplug.spotless.extra.glue.jdt;
 
 import org.eclipse.core.runtime.Assert;
@@ -10,14 +25,17 @@
 import org.eclipse.jdt.core.dom.Modifier;
 import org.eclipse.jdt.core.dom.TypeDeclaration;
 
+/**
+ * This class is derived and adapted code from the Eclipse JDT project (Derivative Works according to EPL 2.0 license).
+ */
 class JdtFlags {
 
-	static final int VISIBILITY_CODE_INVALID= 	-1;
+	static final int VISIBILITY_CODE_INVALID = -1;
 
 	static boolean isStatic(BodyDeclaration bodyDeclaration) {
 		if (isNestedInterfaceOrAnnotation(bodyDeclaration))
 			return true;
-		int nodeType= bodyDeclaration.getNodeType();
+		int nodeType = bodyDeclaration.getNodeType();
 		if (nodeType != ASTNode.METHOD_DECLARATION
 				&& nodeType != ASTNode.ANNOTATION_TYPE_MEMBER_DECLARATION
 				&& isInterfaceOrAnnotationMember(bodyDeclaration))
@@ -30,7 +48,7 @@ && isInterfaceOrAnnotationMember(bodyDeclaration))
 	}
 
 	private static boolean isPackageVisible(BodyDeclaration bodyDeclaration) {
-		return (! isPrivate(bodyDeclaration) && ! isProtected(bodyDeclaration) && ! isPublic(bodyDeclaration));
+		return (!isPrivate(bodyDeclaration) && !isProtected(bodyDeclaration) && !isPublic(bodyDeclaration));
 	}
 
 	private static boolean isPrivate(BodyDeclaration bodyDeclaration) {
@@ -52,8 +70,8 @@ private static boolean isInterfaceOrAnnotationMember(BodyDeclaration bodyDeclara
 	}
 
 	private static boolean isInterfaceOrAnnotation(ASTNode node) {
-		boolean isInterface= (node instanceof TypeDeclaration) && ((TypeDeclaration) node).isInterface();
-		boolean isAnnotation= node instanceof AnnotationTypeDeclaration;
+		boolean isInterface = (node instanceof TypeDeclaration) && ((TypeDeclaration) node).isInterface();
+		boolean isAnnotation = node instanceof AnnotationTypeDeclaration;
 		return isInterface || isAnnotation;
 	}
 

lib-extra/src/jdt/java/com/diffplug/spotless/extra/glue/jdt/JdtFlags.java

@@ -59,11 +59,11 @@ public abstract class EquoBasedStepBuilder {
 
 	/** Initialize valid default configuration, taking latest version */
 	public EquoBasedStepBuilder(
-		String formatterName,
-		Provisioner mavenProvisioner,
-		@Nullable String defaultVersion,
-		SerializedFunction<State, FormatterFunc> stateToFormatter,
-		ImmutableMap.Builder<String, String> stepProperties) {
+			String formatterName,
+			Provisioner mavenProvisioner,
+			@Nullable String defaultVersion,
+			SerializedFunction<State, FormatterFunc> stateToFormatter,
+			ImmutableMap.Builder<String, String> stepProperties) {
 
 		this.formatterName = formatterName;
 		this.mavenProvisioner = mavenProvisioner;
@@ -169,10 +169,10 @@ static class EquoStep implements Serializable {
 		private final ImmutableMap<String, String> stepProperties;
 
 		EquoStep(
-			String semanticVersion,
-			FileSignature.Promised settingsPromise,
-			JarState.Promised jarPromise,
-			ImmutableMap<String, String> stepProperties) {
+				String semanticVersion,
+				FileSignature.Promised settingsPromise,
+				JarState.Promised jarPromise,
+				ImmutableMap<String, String> stepProperties) {
 
 			this.semanticVersion = semanticVersion;
 			this.settingsPromise = settingsPromise;

lib-extra/src/main/java/com/diffplug/spotless/extra/EquoBasedStepBuilder.java

@@ -57,11 +57,11 @@ public static class Builder extends EquoBasedStepBuilder {
 		private final ImmutableMap.Builder<String, String> stepProperties;
 
 		Builder(
-			String formatterName,
-			Provisioner mavenProvisioner,
-			String defaultVersion,
-			SerializedFunction<State, FormatterFunc> stateToFormatter,
-			ImmutableMap.Builder<String, String> stepProperties) {
+				String formatterName,
+				Provisioner mavenProvisioner,
+				String defaultVersion,
+				SerializedFunction<State, FormatterFunc> stateToFormatter,
+				ImmutableMap.Builder<String, String> stepProperties) {
 			super(formatterName, mavenProvisioner, defaultVersion, stateToFormatter, stepProperties);
 			this.stepProperties = stepProperties;
 		}

lib-extra/src/main/java/com/diffplug/spotless/extra/java/EclipseJdtFormatterStep.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,7 +33,7 @@ public void issue_1638() {
 		EquoBasedStepBuilder builder = EclipseJdtFormatterStep.createBuilder(TestProvisioner.mavenCentral());
 		builder.setPreferences(List.of(file));
 		StepHarness.forStep(builder.build())
-			.testResource("java/eclipse/AbstractType.test", "java/eclipse/AbstractType.clean");
+				.testResource("java/eclipse/AbstractType.test", "java/eclipse/AbstractType.clean");
 	}
 
 	@Test
@@ -42,7 +42,7 @@ public void sort_members_no_fields() {
 		EclipseJdtFormatterStep.Builder builder = EclipseJdtFormatterStep.createBuilder(TestProvisioner.mavenCentral());
 		builder.setMembersOrdering("SF,SI,SM,F,I,C,M,T", true);
 		StepHarness.forStep(builder.build())
-			.testResource("java/eclipse/SortExample.test", "java/eclipse/SortExample.sortMembersNoFields.clean");
+				.testResource("java/eclipse/SortExample.test", "java/eclipse/SortExample.sortMembersNoFields.clean");
 	}
 
 	@Test
@@ -51,7 +51,7 @@ public void sort_members() {
 		EclipseJdtFormatterStep.Builder builder = EclipseJdtFormatterStep.createBuilder(TestProvisioner.mavenCentral());
 		builder.setMembersOrdering("SF,SI,SM,F,I,C,M,T", false);
 		StepHarness.forStep(builder.build())
-			.testResource("java/eclipse/SortExample.test", "java/eclipse/SortExample.sortMembers.clean");
+				.testResource("java/eclipse/SortExample.test", "java/eclipse/SortExample.sortMembers.clean");
 	}
 
 	@Test
@@ -61,6 +61,6 @@ public void sort_members_and_by_visibility() {
 		builder.setMembersOrdering("SF,SI,SM,F,I,C,M,T", false);
 		builder.setVisibilityOrdering("B,R,D,V");
 		StepHarness.forStep(builder.build())
-			.testResource("java/eclipse/SortExample.test", "java/eclipse/SortExample.sortMembersByVisibility.clean");
+				.testResource("java/eclipse/SortExample.test", "java/eclipse/SortExample.sortMembersByVisibility.clean");
 	}
 }

lib-extra/src/test/java/com/diffplug/spotless/extra/java/EclipseJdtFormatterStepSpecialCaseTest.java

@@ -33,7 +33,6 @@
 import org.gradle.api.tasks.SourceSet;
 
 import com.diffplug.spotless.FormatterStep;
-import com.diffplug.spotless.extra.EquoBasedStepBuilder;
 import com.diffplug.spotless.extra.java.EclipseJdtFormatterStep;
 import com.diffplug.spotless.generic.LicenseHeaderStep;
 import com.diffplug.spotless.java.CleanthatJavaStep;
@@ -314,9 +313,9 @@ public EclipseConfig sortMembers(String memberCategoryOrder, boolean doNotSortFi
 		}
 
 		public EclipseConfig sortMembers(
-			String memberCategoryOrder,
-			boolean doNotSortFields,
-			String visibilityOrder) {
+				String memberCategoryOrder,
+				boolean doNotSortFields,
+				String visibilityOrder) {
 			requireElementsNonNull(memberCategoryOrder);
 			requireElementsNonNull(visibilityOrder);
 			builder.setMembersOrdering(memberCategoryOrder, doNotSortFields);