KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > update > core > IURLEntry


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 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.update.core;
12
13 import java.net.*;
14
15 import org.eclipse.core.runtime.*;
16
17 /**
18  * URL entry is an annotated URL object. It allows descriptive text to be
19  * associated with a URL. When used as description object, the annotation
20  * typically corresponds to short descriptive text, with the URL reference
21  * pointing to full browsable description.
22  * <p>
23  * Clients may implement this interface. However, in most cases clients should
24  * directly instantiate or subclass the provided implementation of this
25  * interface.
26  * </p>
27  * <p>
28  * <b>Note:</b> This class/interface is part of an interim API that is still under development and expected to
29  * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
30  * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
31  * (repeatedly) as the API evolves.
32  * </p>
33  * @see org.eclipse.update.core.URLEntry
34  * @since 2.0
35  */
36 public interface IURLEntry extends IAdaptable {
37
38     public static final int UPDATE_SITE = 0;
39     public static final int WEB_SITE = 1;
40
41     /**
42      * Returns the URL annotation or <code>null</code> if none
43      *
44      * @return url annotation or <code>null</code> if none
45      * @since 2.0
46      */
47     public String JavaDoc getAnnotation();
48
49     /**
50      * Returns the actual URL.
51      *
52      * @return url.
53      * @since 2.0
54      */
55     public URL getURL();
56     
57     /**
58      * Returns the type of the URLEntry
59      *
60      * @see #UPDATE_SITE
61      * @see #WEB_SITE
62      * @return type
63      * @since 2.0
64      */
65     public int getType();
66 }
67
Popular Tags