org.mule.runtime.connectivity.api.platform.schema.generator

Interface ConnectivitySchemaGeneratorBuilder

All Known Implementing Classes:

DefaultConnectivitySchemaGeneratorBuilder

@NoImplement
public interface ConnectivitySchemaGeneratorBuilder

Builder for creating ConnectivitySchemaGenerator instances

Since:

1.0

Method Summary

Modifier and Type	Method and Description
ConnectivitySchemaGenerator	build() Creates and returns a new generator based on this configuration.
static ConnectivitySchemaGeneratorBuilder	newInstance()
ConnectivitySchemaGeneratorBuilder	setConnectionPredicate(Function<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel,Boolean> predicate) Specifies a Function which evaluates if a ConnectionProviderModel should be added to the generated schema or not.
ConnectivitySchemaGeneratorBuilder	setConnectionTermsExtractor(Function<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel,Set<String>> connectionTermsExtractor) Specifies the Function which will be used to extract the semantic terms out of a ConnectionProviderModel instance.
ConnectivitySchemaGeneratorBuilder	setParameterPredicate(BiFunction<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel,org.mule.runtime.api.meta.model.parameter.ParameterModel,Boolean> predicate) Specifies a Function which evaluates if a ParameterModel should be added to the generated schema or not.
ConnectivitySchemaGeneratorBuilder	setParameterTermsExtractor(Function<org.mule.runtime.api.meta.model.parameter.ParameterModel,Set<String>> parameterTermsExtractor) Specifies the Function which will be used to extract the semantic terms out of a ParameterModel instance.
ConnectivitySchemaGeneratorBuilder	setTypeTermsExtractor(Function<org.mule.metadata.api.model.MetadataType,Set<String>> typeTermsExtractor) Specifies the Function which will be used to extract the semantic terms out of a MetadataType instance.

Method Detail

newInstance

static ConnectivitySchemaGeneratorBuilder newInstance()

Returns:

a new builder instance

setConnectionTermsExtractor

ConnectivitySchemaGeneratorBuilder setConnectionTermsExtractor(Function<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel,Set<String>> connectionTermsExtractor)

Specifies the Function which will be used to extract the semantic terms out of a ConnectionProviderModel instance.

Providing a function through this method is mandatory. build() method will fail if this method has not been previously invoked

Parameters:

connectionTermsExtractor - a extraction function

Returns:

this builder

setParameterTermsExtractor

ConnectivitySchemaGeneratorBuilder setParameterTermsExtractor(Function<org.mule.runtime.api.meta.model.parameter.ParameterModel,Set<String>> parameterTermsExtractor)

Specifies the Function which will be used to extract the semantic terms out of a ParameterModel instance.

Providing a function through this method is mandatory. build() method will fail if this method has not been previously invoked

Parameters:

parameterTermsExtractor - a extraction function

Returns:

this builder

setTypeTermsExtractor

ConnectivitySchemaGeneratorBuilder setTypeTermsExtractor(Function<org.mule.metadata.api.model.MetadataType,Set<String>> typeTermsExtractor)

Specifies the Function which will be used to extract the semantic terms out of a MetadataType instance.

Providing a function through this method is mandatory. build() method will fail if this method has not been previously invoked

Parameters:

typeTermsExtractor - a extraction function

Returns:

this builder

setConnectionPredicate

ConnectivitySchemaGeneratorBuilder setConnectionPredicate(Function<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel,Boolean> predicate)

Specifies a Function which evaluates if a ConnectionProviderModel should be added to the generated schema or not. Models for which this predicate yields a false value will be ignored.

Parameters:

predicate - A predicate Function

Returns:

this builder

setParameterPredicate

ConnectivitySchemaGeneratorBuilder setParameterPredicate(BiFunction<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel,org.mule.runtime.api.meta.model.parameter.ParameterModel,Boolean> predicate)

Specifies a Function which evaluates if a ParameterModel should be added to the generated schema or not. Models for which this predicate yields a false value will be ignored.

Parameters:

predicate - A predicate Function

Returns:

this builder

build

ConnectivitySchemaGenerator build()

Creates and returns a new generator based on this configuration.

Returns:

a new ConnectivitySchemaGenerator

Throws:

IllegalStateException - if any of the mandatory methods haven't been previously invoked on this instance