org.eclipse.ui.IURIEditorInput Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.ui.ide Show documentation

Eclipse IDE UI

There is a newer version: 3.22.400

/*******************************************************************************
 * Copyright (c) 2006, 2007  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.ui;

import java.net.URI;

/**
 * This interface defines an editor input based on a URI.
 * 
 * Clients implementing this editor input interface should override
 * Object.equals(Object) to answer true for two inputs
 * that are the same. The IWorkbenchPage.openEditor APIs
 * are dependent on this to find an editor with the same input.
 * 

 * Path-oriented editors should support this as a valid input type, and
 * can allow full read-write editing of its content.
 * 

 * All editor inputs must implement the IAdaptable interface;
 * extensions are managed by the platform's adapter manager.
 * 
 *
 * @see URI
 * @since 3.3
 */
public interface IURIEditorInput extends IEditorInput {
	/**
	 * Returns the {@link URI} of the file underlying this editor input.
	 *
	 * @return {@link URI}
	 */
	public URI getURI();
}