com.diffplug.spotless.extra.eclipse.base.SpotlessEclipsePluginConfig 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 java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Objects;

import org.osgi.framework.Bundle;
import org.osgi.framework.BundleActivator;

import com.diffplug.spotless.extra.eclipse.base.SpotlessEclipseFramework.DefaultPlugins;
import com.diffplug.spotless.extra.eclipse.base.osgi.BundleConfig;

/**
 * Configuration of plugins which shall be provided by the
 * {@link SpotlessEclipseFramework}.
 * 
 * Plugins are registered via the Eclipse registry. Therefore they
 * required a {@code plugin.xml} configuration description.
 * Note that a plugin does not necessarily derive from the
 * Eclipse {@link org.eclipse.core.runtime.Plugin} class.
 * 
 * 
 * Some plugins are pure extensions without any activator.
 * For resource and plugin information lookup, a class can be
 * specified which is in the JAR containing the resources and
 * plugin information. This lookup procedure also supports
 * fat JAR lookups as described in the ReadMe.md.
 * 
 * @see org.eclipse.core.runtime.RegistryFactory
 */
public class SpotlessEclipsePluginConfig extends BundleConfig {
	private final List> extensions;

	/**
	 * Don't instantiate and call {@link SpotlessEclipseConfig} directly.
	 * Registered plugins and extensions should only be instantiated once, since
	 * some still abusing singletons for access.
	 */
	SpotlessEclipsePluginConfig() {
		extensions = new ArrayList<>();
	}

	/** Add an extension plugin, identified by a class of the plugin. */
	public void add(Class extensionClass) {
		Objects.requireNonNull(extensionClass, "Plugin extension class must nor be null");
		extensions.add(extensionClass);
	}

	/** Add a set of default bundles with their default states */
	public void add(Class... extensionClasses) {
		Arrays.asList(extensionClasses).forEach(extensionClass -> add(extensionClass));
	}

	/** Returns the current configuration */
	public List> getExtensions() {
		return extensions;
	}

	@Override
	public void applyDefault() {
		add(SpotlessEclipseFramework.DefaultPlugins.createAll());
	}

	@Override
	protected BundleActivator create(DefaultPlugins bundle) {
		return bundle.create();
	}

	@Override
	protected int getDefaultState(DefaultPlugins bundle) {
		return Bundle.ACTIVE;
	}

}