com.diffplug.spotless.maven.xml.Xml 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.BETA2

Show newest version

/*
 * Copyright 2016 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.xml;

import java.util.Set;
import java.util.stream.Collectors;

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

/**
 * A {@link FormatterFactory} implementation that corresponds to {@code ...} configuration element.
 * 

 * It defines a formatter for XML/XSL/... source files that can execute both language agnostic (e.g. {@link LicenseHeader})
 * and xml-specific (e.g. {@link Eclipse}) steps.
 * 

 * The XML extension is discontinued. XML formatters are now part of the generic {@link FormatterFactory}.
  */
@Deprecated
public class Xml extends FormatterFactory {

	private static final Set DEFAULT_INCLUDES = XmlDefaults.FILE_FILTER
			.stream().map(s -> "src/" + s).collect(Collectors.toSet());

	@Override
	public Set defaultIncludes() {
		return DEFAULT_INCLUDES;
	}

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

	@Override
	public String licenseHeaderDelimiter() {
		return XmlDefaults.DELIMITER_EXPR;
	}

}