org.revapi.simple

Class SimpleConfigurable

java.lang.Object

org.revapi.simple.SimpleConfigurable

All Implemented Interfaces:

AutoCloseable, Configurable

Direct Known Subclasses:

CollectingReporter, SimpleDifferenceTransform, SimpleElementFilter, SimpleReporter

public abstract class SimpleConfigurable
extends Object
implements AutoCloseable, Configurable

Since:

0.4.0

Author:

Lukas Krejci

Constructor Summary

Constructors

Constructor and Description
SimpleConfigurable()

Method Summary

Modifier and Type	Method and Description
void	close()
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

SimpleConfigurable

public SimpleConfigurable()

Method Detail

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

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