IIndexContribution


1   /*******************************************************************************
2    * Copyright (c) 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.help;
12  
13  /**
14   * Represents either a complete or partial keyword index, as well as its
15   * metadata.
16   * 
17   * @since 3.3
18   */
19  public interface IIndexContribution {
20  
21      /**
22       * Returns a unique identifier for this contribution.
23       * 
24       * @return the contribution's unique identifier
25       */
26      public String   getId();
27  
28      /**
29       * Returns this contributions index.
30       * 
31       * @return the index data for this contribution
32       */
33      public IIndex getIndex();
34  
35      /**
36       * Returns the locale for this contribution.
37       * 
38       * @return the contribution's locale
39       */
40      public String   getLocale();
41  }
42

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

Popular Tags