org.springframework.xd.module.options

Class HierarchicalCompositeModuleOptionsMetadata

java.lang.Object

org.springframework.xd.module.options.HierarchicalCompositeModuleOptionsMetadata

All Implemented Interfaces:

java.lang.Iterable<ModuleOption>, ModuleOptionsMetadata

public class HierarchicalCompositeModuleOptionsMetadata
extends java.lang.Object
implements ModuleOptionsMetadata

A composite ModuleOptionsMetadata made of several ModuleOptionsMetadata, each assigned to a name, that will appear in a hierarchy. Used to represent options to a composite module.

Author:

Eric Bottard, Gary Russell

Constructor Summary

Constructors

Constructor and Description
HierarchicalCompositeModuleOptionsMetadata(java.util.Map<java.lang.String,ModuleOptionsMetadata> hierarchy)

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.
java.util.Iterator<ModuleOption>	iterator()

Methods inherited from class java.lang.Object

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

Constructor Detail

HierarchicalCompositeModuleOptionsMetadata

public HierarchicalCompositeModuleOptionsMetadata(java.util.Map<java.lang.String,ModuleOptionsMetadata> hierarchy)

Method Detail

iterator

public java.util.Iterator<ModuleOption> iterator()

Specified by:

iterator in interface java.lang.Iterable<ModuleOption>

interpolate

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

Description copied from interface: ModuleOptionsMetadata

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

Specified by:

interpolate in interface ModuleOptionsMetadata

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