org.mule.devkit.generation.spring.schema.global.util

Interface GlobalElementSchemaBuilderResolver

public interface GlobalElementSchemaBuilderResolver

Global element callback for resolving schemas

Method Summary

Methods

Modifier and Type	Method and Description
String	resolveConfigElementName(Module module) Given a module, it returns the global element config name.
List<Field>	resolveConfigurableFields(Module module) Returns the list of configurable fields for the given module and the current global element (this might end in mixing up the configurables from the module plus the ones of each concrete strategy)
String	resolveJavaDocSummary(Module module) Returns the javadoc for the specific global element for this resolver that will be added to the schema
void	resolvePostGenerationGroup(Module module, ExtensionType config, ExplicitGroup all) Once the schema has been generated for the concrete global element, this hook will allow each specific implementation add a concrete behaviour to the schema.

Method Detail

resolveConfigElementName

String resolveConfigElementName(Module module)

Given a module, it returns the global element config name. Usually "config", or "config-with-oauth"

Parameters:

module -

Returns:

resolveConfigurableFields

List<Field> resolveConfigurableFields(Module module)

Returns the list of configurable fields for the given module and the current global element (this might end in mixing up the configurables from the module plus the ones of each concrete strategy)

Parameters:

module -

Returns:

resolvePostGenerationGroup

void resolvePostGenerationGroup(Module module,
                              ExtensionType config,
                              ExplicitGroup all)

Once the schema has been generated for the concrete global element, this hook will allow each specific implementation add a concrete behaviour to the schema.

Parameters:

module -

config - element that represents the global element

all - element sequence/group of the parametrized config element

resolveJavaDocSummary

String resolveJavaDocSummary(Module module)

Returns the javadoc for the specific global element for this resolver that will be added to the schema

Parameters:

module -

Returns: