org.eclipse.equinox.p2.metadata.IProvidedCapability Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.equinox.p2.metadata Show documentation

The newest version!

/******************************************************************************* 
* Copyright (c) 2008, 2012 EclipseSource and others. All rights reserved. This
* program and the accompanying materials are made available under the terms of
* the Eclipse Public License v1.0 which accompanies this distribution, and is
* available at http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
*   EclipseSource - initial API and implementation
 *   IBM - ongoing development
******************************************************************************/
package org.eclipse.equinox.p2.metadata;

/**
 * Describes a capability that is exposed by an installable unit. These capabilities
 * can satisfy the dependencies of other installable units, causing the unit
 * providing the dependency to be installed.
 * 
 * Instances of this class are handle objects and do not necessarily
 * reflect entities that exist in any particular profile or repository. These handle 
 * objects can be created using {@link MetadataFactory}.
 * 
 * 
 * @noimplement This interface is not intended to be implemented by clients.
 * @noextend This interface is not intended to be extended by clients.
 * @since 2.0
 * @see IRequirement
 */
public interface IProvidedCapability {

	/**
	 * 
	 * @return String
	 * @noreference This method is not intended to be referenced by clients.
	 */
	public String getName();

	/**
	 * 
	 * @return String
	 * @noreference This method is not intended to be referenced by clients.
	 */
	public String getNamespace();

	/**
	 * 
	 * @return String
	 * @noreference This method is not intended to be referenced by clients.
	 */
	public Version getVersion();

	/**
	 * Returns whether this provided capability is equal to the given object.
	 * 
	 * This method returns true if:
	 * 
	 *   Both this object and the given object are of type IProvidedCapability
	 *  
 The result of getName() on both objects are equal
	 *  
 The result of getNamespace() on both objects are equal
	 *  
 The result of getVersion() on both objects are equal
	 *  
	 */
	public boolean equals(Object other);

}