org.eclipse.core.runtime.spi.RegistryContributor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of aspectjtools Show documentation

AspectJ tools most notably contains the AspectJ compiler (AJC). AJC applies aspects to Java classes during compilation, fully replacing Javac for plain Java classes and also compiling native AspectJ or annotation-based @AspectJ syntax. Furthermore, AJC can weave aspects into existing class files in a post-compile binary weaving step. This library is a superset of AspectJ weaver and hence also of AspectJ runtime.

There is a newer version: 1.9.22.1

Show newest version

/*******************************************************************************
 * Copyright (c) 2006, 2014 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.core.runtime.spi;

import org.eclipse.core.runtime.IContributor;

/**
 * This class describes a registry contributor which is an entity that supplies information
 * to the extension registry. Depending on the registry strategy, contributor might delegate
 * some of its functionality to a "host" contributor. For instance, OSGi registry strategy
 * uses "host" contributor to delegate some functionality from fragments to plug-ins.
 * 
 * This class can be instantiated by the registry Service Providers.
 * 

 * This class can be used without OSGi running.
 * 

 * This class can not be extended.
 * 
 * @since org.eclipse.equinox.registry 3.2
 * @noextend This class is not intended to be subclassed by clients.
 */
public final class RegistryContributor implements IContributor {

	/**
	 * Actual ID of the contributor (e.g., "12"). IDs are expected to be unique in the workspace.
	 */
	private String actualContributorId;

	/**
	 * Actual name of the contributor (e.g., "org.eclipse.core.runtime.fragment").
	 */
	private String actualContributorName;

	/**
	 * ID associated with the entity "in charge" of the contributor (e.g., "1"). IDs are expected
	 * to be unique in the workspace. If contributor does not rely on a host, this value should be
	 * the same as the actual contributor ID.
	 */
	private String hostId;

	/**
	 * Name of the entity "in charge" of the contributor (e.g. "org.eclipse.core.runtime").
	 * If contributor does not rely on a host, this value should be the same as the actual
	 * contributor name.
	 */
	private String hostName;

	/**
	 * Constructor for the registry contributor.
	 * 
	 * The actual ID is a string identifier for the contributor (e.g., "12") and is expected
	 * to be unique within the workspace. The actual ID of the contributor must not
	 * be null.
	 * 

	 * The actual name is the name associated with the contributor
	 * (e.g., "org.eclipse.core.runtime.fragment"). The actual name of the contributor must
	 * not be null.
	 * 

	 * The host ID is the identifier associated with the entity "in charge" of the contributor
	 * (e.g., "1"). IDs are expected to be unique in the workspace. If contributor does not
	 * rely on a host, then null should be used as the host ID.
	 * 

	 * The host name is the name of the entity "in charge" of the contributor
	 * (e.g., "org.eclipse.core.runtime"). If contributor does not rely on a host, then
	 * null should be used as the host name.
	 * 

	 * There should be 1-to-1 mapping between the contributor and the contibutor ID.
	 * The IDs (either actual or host) can not be re-used in the same registry.
	 * For example, if ID of 12 was used to identify contributorA, the ID of 12 can not
	 * be used to identify contributorB or a host for the contributorC.
	 * 
	 * @param actualId contributor identifier
	 * @param actualName name of the contributor
	 * @param hostId id associated with the host, or null
	 * @param hostName name of the host, or null
	 */
	public RegistryContributor(String actualId, String actualName, String hostId, String hostName) {
		this.actualContributorId = actualId;
		this.actualContributorName = actualName;
		if (hostId != null) {
			this.hostId = hostId;
			this.hostName = hostName;
		} else {
			this.hostId = actualId;
			this.hostName = actualName;
		}
	}

	/**
	 * Provides actual ID associated with the registry contributor (e.g., "12"). IDs are expected
	 * to be unique in the workspace.
	 *
	 * @return actual ID of the registry contributor
	 */
	public String getActualId() {
		return actualContributorId;
	}

	/**
	 * Provides actual name of the registry contributor (e.g., "org.eclipe.core.runtime.fragment").
	 *
	 * @return actual name of the registry contributor
	 */
	public String getActualName() {
		return actualContributorName;
	}

	/**
	 * Provides ID associated with the entity "in charge" of the contributor (e.g., "1"). IDs are expected
	 * to be unique in the workspace. If contributor does not rely on a host, this value should be
	 * the same as the actual contributor ID.
	 *
	 * @return id of the registry contributor
	 */
	public String getId() {
		return hostId;
	}

	/**
	 * Provides name of the entity "in charge" of the contributor (e.g., "org.eclipse.core.runtime").
	 * If contributor does not rely on a host, this value should be the same as the actual contributor name.
	 *
	 * @return name of the registry contributor
	 */
	@Override
	public String getName() {
		return hostName;
	}

	/* (non-Javadoc)
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString() {
		return actualContributorName + "[" + actualContributorId + "]"; //$NON-NLS-1$ //$NON-NLS-2$
	}
}