com.diffplug.spotless.maven.pom.Pom Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2021 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.pom;

import java.util.Set;

import com.diffplug.common.collect.ImmutableSet;
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 Maven pom files that can execute both language agnostic (e.g. {@link LicenseHeader})
 * and pom-specific (e.g. {@link SortPom}) steps.
 */
public class Pom extends FormatterFactory {
	@Override
	public Set defaultIncludes() {
		return ImmutableSet.of("pom.xml");
	}

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

	public void addSortPom(SortPom sortPom) {
		addStepFactory(sortPom);
	}

}