KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > IURIEditorInput


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