com.diffplug.spotless.extra.eclipse.base.SpotlessEclipseServiceConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spotless-eclipse-base Show documentation
Eclipse bundle controller and services for Spotless
There is a newer version: 3.5.2
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.extra.eclipse.base;

import static com.diffplug.spotless.extra.eclipse.base.SpotlessEclipseFramework.LINE_DELIMITER;

import java.util.Map;
import java.util.function.BiFunction;

import org.eclipse.core.runtime.content.IContentTypeManager;
import org.eclipse.core.runtime.preferences.IPreferencesService;
import org.eclipse.equinox.log.ExtendedLogReaderService;
import org.eclipse.equinox.log.ExtendedLogService;
import org.eclipse.osgi.service.datalocation.Location;
import org.eclipse.osgi.service.debug.DebugOptions;
import org.eclipse.osgi.service.environment.EnvironmentInfo;
import org.osgi.framework.ServiceException;
import org.osgi.service.log.LogLevel;

import com.diffplug.spotless.extra.eclipse.base.service.*;

/**
 * Configuration/Provision of services which shall be provided by the {@link SpotlessEclipseFramework}.
 * 
 * The services provide basic functions/configuration to the {@link SpotlessEclipseFramework} bundles use the services.
 * Hence the services can be used to customize the behavior of core bundles and plugins configured
 * in the {@link SpotlessEclipseCoreConfig} and {@link SpotlessEclipsePluginConfig}.
 * 
 */
public interface SpotlessEclipseServiceConfig {

	/** Sets property/preference value available to all bundles, plugins and services. */
	void set(String key, String value);

	/** Sets property/preference values available to all bundles, plugins and services. */
	default void set(Map properties) {
		properties.forEach((k, v) -> this.set(k, v));
	}

	/**
	 * Add custom service to collection.
	 * 
	 * Only one service per interface is allowed.
	 * A service instance implementing multiple interfaces, can be added for each interface.
	 * 
	 * Please refer to the default method implementation for examples.
	 *
	 * @param interfaceClass Service interface
	 * @param service Service instance
	 * @throws ServiceException in case service has already been configured
	 */
	public  void add(Class interfaceClass, S service) throws ServiceException;

	/**
	 * Spotless formatters should not be configured by environment variables, and
	 * they shall be OS independent.
	 * @throws ServiceException in case service has already been configured
	 */
	default public void hideEnvironment() throws ServiceException {
		add(EnvironmentInfo.class, new HiddenEnvironment());
	}

	/**
	 * Eclipse provides means to lookup the file content type, e.g. by file name extensions.
	 * This possibility is not required by most Spotless formatters.
	 * @throws ServiceException in case service has already been configured
	 */
	default public void ignoreContentType() throws ServiceException {
		add(IContentTypeManager.class, new NoContentTypeSpecificHandling());
	}

	/**
	 * Disable Eclipse internal debugging.
	 * @throws ServiceException in case service has already been configured
	 */
	default public void disableDebugging() throws ServiceException {
		add(DebugOptions.class, new NoDebugging());
	}

	/**
	 * Ignore accesses of unsupported preference.
	 * @throws ServiceException in case service has already been configured
	 */
	default public void ignoreUnsupportedPreferences() throws ServiceException {
		add(IPreferencesService.class, new NoEclipsePreferences());
	}

	/**
	 * Use temporary locations in case plugins require to store file.
	 * These files (for example workspace preferences) will be deleted
	 * as soon as the application terminates.
	 * @throws ServiceException in case service has already been configured
	 */
	default public void useTemporaryLocations() throws ServiceException {
		add(Location.class, new TemporaryLocation());
	}

	/**
	 * In case the string which will be formatted does not contain any
	 * line delimiter (single line), Eclipse falls back to use the
	 * system property.
	 * Change the system default to the UNIX line separator as required
	 * by Spotless.
	 * @throws ServiceException in case service has already been configured
	 */
	default public void changeSystemLineSeparator() throws ServiceException {
		System.setProperty("line.separator", LINE_DELIMITER);
	}

	/**
	 * Adds Eclipse logging service Slf4J binding.
	 * @throws ServiceException in case service has already been configured
	 */
	default public void useSlf4J(String loggerName) {
		useSlf4J(loggerName, (s, l) -> s);
	}

	/**
	 * Adds Eclipse logging service Slf4J binding with a message customizer function.
	 * @throws ServiceException in case service has already been configured
	 */
	default public void useSlf4J(String loggerName, BiFunction messageCustomizer) throws ServiceException {
		SingleSlf4JService slf4jServce = new SingleSlf4JService(loggerName, messageCustomizer);
		add(ExtendedLogService.class, slf4jServce);
		add(ExtendedLogReaderService.class, slf4jServce);
		slf4jServce.debug("Initialized Eclipse logging service.");
	}

	/**
	 * Applies the default configurations.
	 * @throws ServiceException in case a service has already been configured
	 */
	default public void applyDefault() throws ServiceException {
		hideEnvironment();
		ignoreContentType();
		disableDebugging();
		ignoreUnsupportedPreferences();
		useTemporaryLocations();
		changeSystemLineSeparator();
	}
}