com.diffplug.spotless.maven.java.Java Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spotless-maven-plugin Show documentation

Spotless - keep your code spotless with Gradle

There is a newer version: 2.44.0.BETA4

Show newest version

/*
 * Copyright 2016-2023 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.maven.java;

import static java.util.stream.Collectors.toSet;

import java.io.File;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Set;
import java.util.stream.Stream;

import org.apache.maven.model.Build;
import org.apache.maven.project.MavenProject;

import com.diffplug.spotless.maven.FormatterFactory;
import com.diffplug.spotless.maven.generic.LicenseHeader;

/**
 * A {@link FormatterFactory} implementation that corresponds to {@code ...} configuration element.
 * 
 * It defines a formatter for java source files that can execute both language agnostic (e.g. {@link LicenseHeader})
 * and java-specific (e.g. {@link Eclipse}) steps.
 */
public class Java extends FormatterFactory {

	private static final String LICENSE_HEADER_DELIMITER = "package ";

	@Override
	public Set defaultIncludes(MavenProject project) {
		Path projectDir = project.getBasedir().toPath();
		Build build = project.getBuild();
		return Stream.of(build.getSourceDirectory(), build.getTestSourceDirectory())
				.map(Paths::get)
				.map(projectDir::relativize)
				.map(Java::fileMask)
				.collect(toSet());
	}

	@Override
	public String licenseHeaderDelimiter() {
		return LICENSE_HEADER_DELIMITER;
	}

	public void addEclipse(Eclipse eclipse) {
		addStepFactory(eclipse);
	}

	public void addGoogleJavaFormat(GoogleJavaFormat googleJavaFormat) {
		addStepFactory(googleJavaFormat);
	}

	public void addImportOrder(ImportOrder importOrder) {
		addStepFactory(importOrder);
	}

	public void addPalantirJavaFormat(PalantirJavaFormat palantirJavaFormat) {
		addStepFactory(palantirJavaFormat);
	}

	public void addRemoveUnusedImports(RemoveUnusedImports removeUnusedImports) {
		addStepFactory(removeUnusedImports);
	}

	public void addFormatAnnotations(FormatAnnotations formatAnnotations) {
		addStepFactory(formatAnnotations);
	}

	public void addCleanthat(CleanthatJava cleanthat) {
		addStepFactory(cleanthat);
	}

	private static String fileMask(Path path) {
		String dir = path.toString();
		if (!dir.endsWith(File.separator)) {
			dir += File.separator;
		}
		return dir + "**" + File.separator + "*.java";
	}
}