apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/problems/IApiProblemFilter.java

/*******************************************************************************
 * Copyright (c) 2008, 2010 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.pde.api.tools.internal.provisional.problems;

import org.eclipse.pde.api.tools.internal.provisional.model.IApiComponent;

/**
 * Describes API problems that should be filtered.
 * <p>
 * Problem filters are created from an {@link IApiComponent}.
 * </p>
 *
 * @since 1.0.0
 */
public interface IApiProblemFilter {

	/**
	 * Returns the identifier of the API component this filter applies to.
	 * Problems contained within this component are potentially filtered.
	 *
	 * @return identifier of the API component this filter applies to
	 */
	public String getComponentId();

	/**
	 * Returns the underlying {@link IApiProblem} for this filter.
	 *
	 * @return the underlying {@link IApiProblem} for this filter
	 */
	public IApiProblem getUnderlyingProblem();

	/**
	 * Returns the comment associated with this filter or <code>null</code> if a
	 * comment has not been added to the filter.
	 *
	 * @return the comment for the filter or <code>null</code>
	 * @since 1.1
	 */
	public String getComment();
}