org.eclipse.core.resources.IProjectNatureDescriptor Maven / Gradle / Ivy

/*******************************************************************************
 *  Copyright (c) 2000, 2009 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.resources;

/**
 * A project nature descriptor contains information about a project nature
 * obtained from the plug-in manifest (plugin.xml) file.
 * 
 * Nature descriptors are platform-defined objects that exist
 * independent of whether that nature's plug-in has been started.
 * In contrast, a project nature's runtime object (IProjectNature)
 * generally runs plug-in-defined code.
 * 
 *
 * @see IProjectNature
 * @see IWorkspace#getNatureDescriptor(String)
 * @since 2.0
 * @noimplement This interface is not intended to be implemented by clients.
 * @noextend This interface is not intended to be extended by clients.
 */
public interface IProjectNatureDescriptor {
	/**
	 * Returns the unique identifier of this nature.
	 * 
	 * The nature identifier is composed of the nature's plug-in id and the simple
	 * id of the nature extension.  For example, if plug-in "com.xyz"
	 * defines a nature extension with id "myNature", the unique
	 * nature identifier will be "com.xyz.myNature".
	 * 
	 * @return the unique nature identifier
	 */
	String getNatureId();

	/**
	 * Returns a displayable label for this nature.
	 * Returns the empty string if no label for this nature
	 * is specified in the plug-in manifest file.
	 *  Note that any translation specified in the plug-in manifest
	 * file is automatically applied.
	 * 
	 *
	 * @return a displayable string label for this nature,
	 *    possibly the empty string
	 */
	String getLabel();

	/**
	 * Returns the unique identifiers of the natures required by this nature.
	 * Nature requirements are specified by the "requires-nature"
	 * element on a nature extension.
	 * Returns an empty array if no natures are required by this nature.
	 *
	 * @return an array of nature ids that this nature requires,
	 * 	possibly an empty array.
	 */
	String[] getRequiredNatureIds();

	/**
	 * Returns the identifiers of the nature sets that this nature belongs to.
	 * Nature set inclusion is specified by the "one-of-nature"
	 * element on a nature extension.
	 * Returns an empty array if no nature sets are specified for this nature.
	 *
	 * @return an array of nature set ids that this nature belongs to,
	 * 	possibly an empty array.
	 */
	String[] getNatureSetIds();

	/**
	 * Returns whether this project nature allows linked resources to be created
	 * in projects where this nature is installed.
	 *
	 * @return boolean true if creating links is allowed,
	 *       and false otherwise.
	 * @see IFolder#createLink(org.eclipse.core.runtime.IPath, int, org.eclipse.core.runtime.IProgressMonitor)
	 * @see IFile#createLink(org.eclipse.core.runtime.IPath, int, org.eclipse.core.runtime.IProgressMonitor)
	 * @since 2.1
	 */
	boolean isLinkingAllowed();
}