01: /*******************************************************************************
02: * Copyright (c) 2006, 2007 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui;
11:
12: import java.net.URI;
13:
14: import org.eclipse.ui.IEditorInput;
15:
16: /**
17: * This interface defines an editor input based on a URI.
18: * <p>
19: * Clients implementing this editor input interface should override
20: * <code>Object.equals(Object)</code> to answer true for two inputs
21: * that are the same. The <code>IWorkbenchPage.openEditor</code> APIs
22: * are dependent on this to find an editor with the same input.
23: * </p><p>
24: * Path-oriented editors should support this as a valid input type, and
25: * can allow full read-write editing of its content.
26: * </p><p>
27: * All editor inputs must implement the <code>IAdaptable</code> interface;
28: * extensions are managed by the platform's adapter manager.
29: * </p>
30: *
31: * @see URI
32: * @since 3.3
33: */
34: public interface IURIEditorInput extends IEditorInput {
35: /**
36: * Returns the {@link URI} of the file underlying this editor input.
37: *
38: * @return {@link URI}
39: */
40: public URI getURI();
41: }
|