edu.cmu.sei.aadl.modelsupport.errorreporting
Interface ParseErrorReporterFactory

All Known Implementing Classes:
ChainedParseErrorReporter.Factory, LogParseErrorReporter.Factory, MarkerParseErrorReporter.Factory, WriterParseErrorReporter.Factory

public interface ParseErrorReporterFactory

Defines the interface for factories that create instances of edu.cmu.sei.aadl.model.pluginsupport.ParseErrorReporter.

Author:
aarong
See Also:
edu.cmu.sei.aadl.model.pluginsupport.ParseErrorReporter, edu.cmu.sei.aadl.model.pluginsupport.ParseErrorReporterManager

Method Summary
 ParseErrorReporter getReporterFor(org.eclipse.core.resources.IResource aadlRsrc)
          Obtain an error reporter to use for the AADL text file associated with the given IResource.
 

Method Detail

getReporterFor

ParseErrorReporter getReporterFor(org.eclipse.core.resources.IResource aadlRsrc)
Obtain an error reporter to use for the AADL text file associated with the given IResource. This method must never return null. If no factory can be found/created then it must throw a IllegalArgumentException.

The given IResource may be null, but an implementation may throw an IllegalArgumentException if it cannot produce a sensible error reporter for null. An implementation must document its behavoir for null inputs.

(At one point a considerable effort was made to avoid having this interface use IResource, on the grounds that it would complicate using the EMF model stand alone, outside of Eclipse. But there is now so much entanglement between the model and Eclipse, that it doesn't seem worth the effort to attempt the separation here.)

Parameters:
aadlRsrc - The IResource of the aadl text file for which an error reporter should be generated. May be null, but see above.
Returns:
The error reporter to be used for the file. Must not be null.
Throws:
java.lang.IllegalArgumentException - Thrown if the factory is unable to create an error reporter for the given resource.