IArchiveReference


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.URL  ;
14  
15  import org.eclipse.core.runtime.IAdaptable;
16  
17  /**
18   * Site archive interface.
19   * Site archive is a representation of a packaged archive (file) located
20   * on an update site. It allows a "symbolic" path used to identify
21   * a plug-in or non-plug-in feature entry to be explicitly mapped
22   * to a specific URL. 
23   * <p>
24   * Clients may implement this interface. However, in most cases clients should 
25   * directly instantiate or subclass the provided implementation of this 
26   * interface.
27   * </p>
28   * <p>
29   * <b>Note:</b> This class/interface is part of an interim API that is still under development and expected to
30   * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
31   * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
32   * (repeatedly) as the API evolves.
33   * </p>
34   * @see org.eclipse.update.core.ArchiveReference
35   * @since 2.0
36   */
37  public interface IArchiveReference extends IAdaptable {
38  
39      /** 
40       * 
41       * @return the archive "symbolic" path, or <code>null</code>
42       * @since 2.0 
43       */
44      public String   getPath();
45  
46      /**
47       * Retrieve the site archive URL 
48       * 
49       * @return the archive URL, or <code>null</code>
50       * @since 2.0 
51       */
52      public URL   getURL();
53  }
54
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags