Package org.revapi.base

Class BaseConfigurable

java.lang.Object

org.revapi.base.BaseConfigurable

All Implemented Interfaces:

Configurable

Direct Known Subclasses:

BaseApiAnalyzer, BaseDifferenceTransform, BaseElementMatcher, BaseReporter, BaseTreeFilterProvider

public abstract class BaseConfigurable
extends Object
implements Configurable

A convenience base class for all configurable types in Revapi.

Constructor Summary

Constructors

Constructor	Description
BaseConfigurable()

Method Summary

Modifier and Type	Method	Description
Reader	getJSONSchema()	This method must not return null if Configurable.getExtensionId() returns a non-null value.
void	initialize(AnalysisContext analysisContext)	The instance can configure itself for the upcoming analysis from the supplied analysis context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.revapi.configuration.Configurable

getExtensionId

Constructor Detail

BaseConfigurable

public BaseConfigurable()

Method Detail

getJSONSchema

@Nullable
public Reader getJSONSchema()

Description copied from interface: Configurable

This method must not return null if Configurable.getExtensionId() returns a non-null value.

Specified by:

getJSONSchema in interface Configurable

Returns:

a json schema to validate the configuration of this configurable against

initialize

public void initialize(@Nonnull
                       AnalysisContext analysisContext)

Description copied from interface: Configurable

The instance can configure itself for the upcoming analysis from the supplied analysis context.

The configuration contained in the supplied analysis context is solely the one provided for this configurable instance and conforms to its schema. Note that this method can be called multiple times, each time for a different analysis run.

Specified by:

initialize in interface Configurable

Parameters:

analysisContext - the context of the upcoming analysis