org.springframework.xd.module.options

Class SimpleModuleOptionsMetadata

java.lang.Object

org.springframework.xd.module.options.SimpleModuleOptionsMetadata

All Implemented Interfaces:

java.lang.Iterable<ModuleOption>, ModuleOptionsMetadata

public class SimpleModuleOptionsMetadata
extends java.lang.Object
implements ModuleOptionsMetadata

An implementation of ModuleOptionsMetadata that only knows how to list options and does not support advanced facilities such as derived options, profile activation or validation.

Author:

Eric Bottard, David Turanski

Constructor Summary

Constructors

Constructor and Description
SimpleModuleOptionsMetadata()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ModuleOption option)
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

SimpleModuleOptionsMetadata

public SimpleModuleOptionsMetadata()

Method Detail

add

public void add(ModuleOption option)

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