org.eclipse.jdt.internal.compiler.apt.dispatch.IProcessorProvider Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2006, 2007 BEA Systems, Inc.
* 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:
* [email protected] - initial API and implementation
*
*******************************************************************************/
package org.eclipse.jdt.internal.compiler.apt.dispatch;
import java.util.List;
import javax.annotation.processing.Processor;
/**
* Implementors know how to discover annotation processors, and maintain a list of processors that
* have been discovered and initialized so far.
*/
public interface IProcessorProvider {
/**
* Return the next processor that can be discovered, according to the order and discovery rules
* of the provider (see, for instance, {@link Processor}.
* @return a ProcessorInfo wrapping an initialized Processor, or null
if there are
* no more processors to be discovered.
*/
ProcessorInfo discoverNextProcessor();
/**
* @return the list of all processors that have been discovered so far. This list will grow when
* {@link #discoverNextProcessor()} is called.
*/
List getDiscoveredProcessors();
/**
* Called when a processor throws an exception. This may abort compilation, throw an
* unchecked exception, etc; the caller should not assume that this method will return.
*
* @param p the processor, if known, or null if not.
* @param e
*/
void reportProcessorException(Processor p, Exception e);
}