KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > update > search > IQueryUpdateSiteAdapter


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 for update site adapter used
15  * for specific query serches. It adds a mapping ID
16  * that can be used when mapping file is specified.
17  * If a matching mapping is found for this ID,
18  * the replacement URL found in the mapping file will be
19  * used instead of this adapter.
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 IQueryUpdateSiteAdapter extends IUpdateSiteAdapter {
29 /**
30  * Returns an ID that can be used for matching against the information in the address mapping file.
31  * @return a mapping Id to compare against the address mapping file.
32  */
33     public String JavaDoc getMappingId();
34
35 }
36
Popular Tags