Home

Contribute

Source code


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

/*******************************************************************************
 * Copyright (c) 2010 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;

/**
 * An <code>AbstractCriteriaDefinitionProvider</code> is a mechanism to provide display name
 * for criteria attached to toc or topic. <code>AbstractCriteriaDefinitionProvider</code>s must be
 * registered via the <code>org.eclipse.help.criteriaDefinition</code> extension point.
 *
 * @since 3.5
 */
public abstract class AbstractCriteriaDefinitionProvider {

	/**
	 * Returns all criteria definition contributions for this provider. Providers
	 * are free to provide any number of contributions (zero or more).
	 *
	 * @param locale the locale for which to get contributions
	 * @return all the criteria definition contributions for this provider
	 */
	public abstract ICriteriaDefinitionContribution[] getCriteriaDefinitionContributions(String locale);
}