com.diffplug.spotless.maven.java.ImportOrder 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 java.io.File;
import java.util.HashSet;
import java.util.Set;

import org.apache.maven.plugins.annotations.Parameter;

import com.diffplug.spotless.FormatterStep;
import com.diffplug.spotless.java.ImportOrderStep;
import com.diffplug.spotless.maven.FormatterStepConfig;
import com.diffplug.spotless.maven.FormatterStepFactory;

public class ImportOrder implements FormatterStepFactory {
	@Parameter
	private String file;

	@Parameter
	private String order;

	@Parameter
	private boolean wildcardsLast = false;

	/**
	 * Whether imports should be sorted based on semantics (i.e. sorted by package,
	 * class and then static member). This considers treatAsPackage and
	 * treatAsClass, and assumes default upper and lower case
	 * conventions otherwise. When turned off, imports are sorted purely
	 * lexicographically.
	 */
	@Parameter
	private boolean semanticSort = false;

	/**
	 * The prefixes that should be treated as packages for
	 * semanticSort. Useful for upper case package names.
	 */
	@Parameter
	private Set treatAsPackage = new HashSet<>();

	/**
	 * The prefixes that should be treated as classes for
	 * semanticSort. Useful for lower case class names.
	 */
	@Parameter
	private Set treatAsClass = new HashSet<>();

	@Override
	public FormatterStep newFormatterStep(FormatterStepConfig config) {
		if (file != null ^ order != null) {
			if (file != null) {
				File importsFile = config.getFileLocator().locateFile(file);
				return ImportOrderStep.forJava().createFrom(wildcardsLast, semanticSort, treatAsPackage, treatAsClass,
						importsFile);
			} else {
				return ImportOrderStep.forJava().createFrom(wildcardsLast, semanticSort, treatAsPackage, treatAsClass,
						order.split(",", -1));
			}
		} else if (file == null && order == null) {
			return ImportOrderStep.forJava().createFrom(wildcardsLast, semanticSort, treatAsPackage, treatAsClass);
		} else {
			throw new IllegalArgumentException("Must specify exactly one of 'file' or 'order'.");
		}
	}
}