IUpdateSearchSite


1   /*******************************************************************************
2    * Copyright (c) 2000, 2005 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.search;
12  
13  /**
14   * This interface is used to represent sites that need to be
15   * searched within the search scope. In addition to being an
16   * update site adapter, it also returns an array of categories
17   * within the site that need not be searched (skipping categories
18   * makes the search faster because fewer features need to
19   * be checked and potentially downloaded from the server).
20   * <p>
21   * <b>Note:</b> This class/interface is part of an interim API that is still under development and expected to
22   * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
23   * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
24   * (repeatedly) as the API evolves.
25   * </p>
26   * @since 3.0
27   */
28  public interface IUpdateSearchSite extends IUpdateSiteAdapter {
29  /**
30   * Returns an array of categories that need not be searched
31   * when scanning this site or <samp>null</samp> if all the
32   * features must be tested.
33   * @return an array of category names or <samp>null</samp> if
34   * all the features must be tested.
35   */
36      String  [] getCategoriesToSkip();
37  }
38

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags