Package org.revapi

Class PipelineConfiguration.Builder

java.lang.Object

org.revapi.PipelineConfiguration.Builder

Enclosing class:

PipelineConfiguration

public static final class PipelineConfiguration.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PipelineConfiguration.Builder	addAnalyzerExtensionIdExclude(String analyzerExtensionId)
PipelineConfiguration.Builder	addAnalyzerExtensionIdInclude(String analyzerExtensionId)
PipelineConfiguration.Builder	addCriticality(Criticality criticality)
PipelineConfiguration.Builder	addFilterExtensionIdExclude(String filterExtensionId)
PipelineConfiguration.Builder	addFilterExtensionIdInclude(String filterExtensionId)
PipelineConfiguration.Builder	addMatcherExtensionIdExclude(String matcherExtensionId)
PipelineConfiguration.Builder	addMatcherExtensionIdInclude(String matcherExtensionId)
PipelineConfiguration.Builder	addReporterExtensionIdExclude(String reporterExtensionId)
PipelineConfiguration.Builder	addReporterExtensionIdInclude(String reporterExtensionId)
PipelineConfiguration.Builder	addSeverityMapping(DifferenceSeverity severity, Criticality criticality)
PipelineConfiguration.Builder	addTransformationBlock(List<String> transformationBlock)
PipelineConfiguration.Builder	addTransformExtensionIdExclude(String transformExtensionId)
PipelineConfiguration.Builder	addTransformExtensionIdInclude(String transformExtensionId)
PipelineConfiguration.Builder	addUntypedSeverityMapping(DifferenceSeverity severity, String criticalityName)
PipelineConfiguration	build()	Returns a new PipelineConfiguration instance.
PipelineConfiguration.Builder	withAllExtensionsFrom(ClassLoader cl)
PipelineConfiguration.Builder	withAllExtensionsFromThreadContextClassLoader()
PipelineConfiguration.Builder	withAnalyzerExtensionIdsExclude(List<String> analyzerExtensionIds)
PipelineConfiguration.Builder	withAnalyzerExtensionIdsInclude(List<String> analyzerExtensionIds)
PipelineConfiguration.Builder	withAnalyzers(Class<? extends ApiAnalyzer>... analyzers)
PipelineConfiguration.Builder	withAnalyzers(Iterable<Class<? extends ApiAnalyzer>> analyzers)
PipelineConfiguration.Builder	withAnalyzersFrom(ClassLoader cl)
PipelineConfiguration.Builder	withAnalyzersFromThreadContextClassLoader()
PipelineConfiguration.Builder	withCriticalities(Set<Criticality> criticalities)
PipelineConfiguration.Builder	withFilterExtensionIdsExclude(List<String> filterExtensionIds)
PipelineConfiguration.Builder	withFilterExtensionIdsInclude(List<String> filterExtensionIds)
PipelineConfiguration.Builder	withFilters(Class<? extends TreeFilterProvider>... filters)
PipelineConfiguration.Builder	withFilters(Iterable<Class<? extends TreeFilterProvider>> filters)
PipelineConfiguration.Builder	withFiltersFrom(ClassLoader cl)
PipelineConfiguration.Builder	withFiltersFromThreadContextClassLoader()
PipelineConfiguration.Builder	withMatcherExtensionIdsExclude(List<String> matcherExtensionIds)
PipelineConfiguration.Builder	withMatcherExtensionIdsInclude(List<String> matcherExtensionIds)
PipelineConfiguration.Builder	withMatchers(Class<? extends ElementMatcher>... filters)
PipelineConfiguration.Builder	withMatchers(Iterable<Class<? extends ElementMatcher>> filters)
PipelineConfiguration.Builder	withMatchersFrom(ClassLoader cl)
PipelineConfiguration.Builder	withMatchersFromThreadContextClassLoader()
PipelineConfiguration.Builder	withReporterExtensionIdsExclude(List<String> reporterExtensionIds)
PipelineConfiguration.Builder	withReporterExtensionIdsInclude(List<String> reporterExtensionIds)
PipelineConfiguration.Builder	withReporters(Class<? extends Reporter>... reporters)
PipelineConfiguration.Builder	withReporters(Iterable<Class<? extends Reporter>> reporters)
PipelineConfiguration.Builder	withReportersFrom(ClassLoader cl)
PipelineConfiguration.Builder	withReportersFromThreadContextClassLoader()
PipelineConfiguration.Builder	withSeverityMapping(Map<DifferenceSeverity,Criticality> severityMapping)
PipelineConfiguration.Builder	withTransformationBlocks(com.fasterxml.jackson.databind.JsonNode configuration)
PipelineConfiguration.Builder	withTransformationBlocks(Set<List<String>> transformationBlocks)
PipelineConfiguration.Builder	withTransformationBlocks(org.jboss.dmr.ModelNode configuration)	Deprecated. use the Jackson-based variant
PipelineConfiguration.Builder	withTransformExtensionIdsExclude(List<String> transformExtensionIds)
PipelineConfiguration.Builder	withTransformExtensionIdsInclude(List<String> transformExtensionIds)
PipelineConfiguration.Builder	withTransforms(Class<? extends DifferenceTransform>... transforms)
PipelineConfiguration.Builder	withTransforms(Iterable<Class<? extends DifferenceTransform>> transforms)
PipelineConfiguration.Builder	withTransformsFrom(ClassLoader cl)
PipelineConfiguration.Builder	withTransformsFromThreadContextClassLoader()
PipelineConfiguration.Builder	withUntypedSeverityMapping(Map<DifferenceSeverity,String> severityMapping)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withAnalyzersFromThreadContextClassLoader

public PipelineConfiguration.Builder withAnalyzersFromThreadContextClassLoader()

withAnalyzersFrom

public PipelineConfiguration.Builder withAnalyzersFrom(ClassLoader cl)

withAnalyzers

@SafeVarargs
public final PipelineConfiguration.Builder withAnalyzers(Class<? extends ApiAnalyzer>... analyzers)

withAnalyzers

public PipelineConfiguration.Builder withAnalyzers(Iterable<Class<? extends ApiAnalyzer>> analyzers)

withReportersFromThreadContextClassLoader

public PipelineConfiguration.Builder withReportersFromThreadContextClassLoader()

withReportersFrom

public PipelineConfiguration.Builder withReportersFrom(ClassLoader cl)

withReporters

@SafeVarargs
public final PipelineConfiguration.Builder withReporters(Class<? extends Reporter>... reporters)

withReporters

public PipelineConfiguration.Builder withReporters(Iterable<Class<? extends Reporter>> reporters)

withTransformsFromThreadContextClassLoader

public PipelineConfiguration.Builder withTransformsFromThreadContextClassLoader()

withTransformsFrom

public PipelineConfiguration.Builder withTransformsFrom(ClassLoader cl)

withTransforms

@SafeVarargs
public final PipelineConfiguration.Builder withTransforms(Class<? extends DifferenceTransform>... transforms)

withTransforms

public PipelineConfiguration.Builder withTransforms(Iterable<Class<? extends DifferenceTransform>> transforms)

withFiltersFromThreadContextClassLoader

public PipelineConfiguration.Builder withFiltersFromThreadContextClassLoader()

withFiltersFrom

public PipelineConfiguration.Builder withFiltersFrom(ClassLoader cl)

withFilters

@SafeVarargs
public final PipelineConfiguration.Builder withFilters(Class<? extends TreeFilterProvider>... filters)

withFilters

public PipelineConfiguration.Builder withFilters(Iterable<Class<? extends TreeFilterProvider>> filters)

withMatchersFromThreadContextClassLoader

public PipelineConfiguration.Builder withMatchersFromThreadContextClassLoader()

withMatchersFrom

public PipelineConfiguration.Builder withMatchersFrom(@Nonnull
                                                      ClassLoader cl)

withMatchers

@SafeVarargs
public final PipelineConfiguration.Builder withMatchers(Class<? extends ElementMatcher>... filters)

withMatchers

public PipelineConfiguration.Builder withMatchers(@Nonnull
                                                  Iterable<Class<? extends ElementMatcher>> filters)

withAllExtensionsFromThreadContextClassLoader

public PipelineConfiguration.Builder withAllExtensionsFromThreadContextClassLoader()

withAllExtensionsFrom

public PipelineConfiguration.Builder withAllExtensionsFrom(ClassLoader cl)

withTransformationBlocks

public PipelineConfiguration.Builder withTransformationBlocks(Set<List<String>> transformationBlocks)

addTransformationBlock

public PipelineConfiguration.Builder addTransformationBlock(List<String> transformationBlock)

withAnalyzerExtensionIdsInclude

public PipelineConfiguration.Builder withAnalyzerExtensionIdsInclude(List<String> analyzerExtensionIds)

addAnalyzerExtensionIdInclude

public PipelineConfiguration.Builder addAnalyzerExtensionIdInclude(String analyzerExtensionId)

withAnalyzerExtensionIdsExclude

public PipelineConfiguration.Builder withAnalyzerExtensionIdsExclude(List<String> analyzerExtensionIds)

addAnalyzerExtensionIdExclude

public PipelineConfiguration.Builder addAnalyzerExtensionIdExclude(String analyzerExtensionId)

withReporterExtensionIdsInclude

public PipelineConfiguration.Builder withReporterExtensionIdsInclude(List<String> reporterExtensionIds)

addReporterExtensionIdInclude

public PipelineConfiguration.Builder addReporterExtensionIdInclude(String reporterExtensionId)

withReporterExtensionIdsExclude

public PipelineConfiguration.Builder withReporterExtensionIdsExclude(List<String> reporterExtensionIds)

addReporterExtensionIdExclude

public PipelineConfiguration.Builder addReporterExtensionIdExclude(String reporterExtensionId)

withTransformExtensionIdsInclude

public PipelineConfiguration.Builder withTransformExtensionIdsInclude(List<String> transformExtensionIds)

addTransformExtensionIdInclude

public PipelineConfiguration.Builder addTransformExtensionIdInclude(String transformExtensionId)

withTransformExtensionIdsExclude

public PipelineConfiguration.Builder withTransformExtensionIdsExclude(List<String> transformExtensionIds)

addTransformExtensionIdExclude

public PipelineConfiguration.Builder addTransformExtensionIdExclude(String transformExtensionId)

withFilterExtensionIdsInclude

public PipelineConfiguration.Builder withFilterExtensionIdsInclude(List<String> filterExtensionIds)

addFilterExtensionIdInclude

public PipelineConfiguration.Builder addFilterExtensionIdInclude(String filterExtensionId)

withFilterExtensionIdsExclude

public PipelineConfiguration.Builder withFilterExtensionIdsExclude(List<String> filterExtensionIds)

addFilterExtensionIdExclude

public PipelineConfiguration.Builder addFilterExtensionIdExclude(String filterExtensionId)

withMatcherExtensionIdsInclude

public PipelineConfiguration.Builder withMatcherExtensionIdsInclude(List<String> matcherExtensionIds)

addMatcherExtensionIdInclude

public PipelineConfiguration.Builder addMatcherExtensionIdInclude(String matcherExtensionId)

withMatcherExtensionIdsExclude

public PipelineConfiguration.Builder withMatcherExtensionIdsExclude(List<String> matcherExtensionIds)

addMatcherExtensionIdExclude

public PipelineConfiguration.Builder addMatcherExtensionIdExclude(String matcherExtensionId)

withTransformationBlocks

@Deprecated
public PipelineConfiguration.Builder withTransformationBlocks(org.jboss.dmr.ModelNode configuration)

Deprecated.

use the Jackson-based variant

withTransformationBlocks

public PipelineConfiguration.Builder withTransformationBlocks(com.fasterxml.jackson.databind.JsonNode configuration)

withCriticalities

public PipelineConfiguration.Builder withCriticalities(Set<Criticality> criticalities)

addCriticality

public PipelineConfiguration.Builder addCriticality(Criticality criticality)

withSeverityMapping

public PipelineConfiguration.Builder withSeverityMapping(Map<DifferenceSeverity,Criticality> severityMapping)

withUntypedSeverityMapping

public PipelineConfiguration.Builder withUntypedSeverityMapping(Map<DifferenceSeverity,String> severityMapping)

addSeverityMapping

public PipelineConfiguration.Builder addSeverityMapping(DifferenceSeverity severity,
                                                        Criticality criticality)

addUntypedSeverityMapping

public PipelineConfiguration.Builder addUntypedSeverityMapping(DifferenceSeverity severity,
                                                               String criticalityName)

build

public PipelineConfiguration build()
                            throws IllegalStateException

Returns a new PipelineConfiguration instance. The builder is reusable after this call and the returned instance is independent of it.

Returns:

a new Revapi pipeline configuration

Throws:

IllegalStateException - if there are no api analyzers or no reporters added.