org.springframework.xd.module.options

Interface ModuleOptionsMetadata

All Superinterfaces:

java.lang.Iterable<ModuleOption>

All Known Implementing Classes:

FlattenedCompositeModuleOptionsMetadata, HierarchicalCompositeModuleOptionsMetadata, PassthruModuleOptionsMetadata, PojoModuleOptionsMetadata, SimpleModuleOptionsMetadata

public interface ModuleOptionsMetadata
extends java.lang.Iterable<ModuleOption>

Encapsulates metadata about the accepted options for a module.

Author:

Eric Bottard

Method Summary

Methods

Modifier and Type	Method and Description
ModuleOptions	interpolate(java.util.Map<java.lang.String,java.lang.String> raw) Derive information about the module behavior once it is part of a stream and user provided values for the module options are known.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

interpolate

ModuleOptions interpolate(java.util.Map<java.lang.String,java.lang.String> raw)
                          throws org.springframework.validation.BindException

Derive information about the module behavior once it is part of a stream and user provided values for the module options are known.

Parameters:

raw - the user provided options (from the DSL stream definition)

Throws:

org.springframework.validation.BindException - if provided values (as well as defaults) failed to validate