blob: 76ca8eade3a39ca737638b5817c9b98ab2316b30 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2007, 2015 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help;
/**
* Represents either a complete or partial keyword index, as well as its
* metadata.
*
* @since 3.3
*/
public interface IIndexContribution {
/**
* Returns a unique identifier for this contribution.
*
* @return the contribution's unique identifier
*/
public String getId();
/**
* Returns this contributions index.
*
* @return the index data for this contribution
*/
public IIndex getIndex();
/**
* Returns the locale for this contribution.
*
* @return the contribution's locale
*/
public String getLocale();
}