org.springframework.xd.module.options

Class PojoModuleOptionsMetadata

java.lang.Object

org.springframework.xd.module.options.PojoModuleOptionsMetadata

All Implemented Interfaces:

java.lang.Iterable<ModuleOption>, ModuleOptionsMetadata

public class PojoModuleOptionsMetadata
extends java.lang.Object
implements ModuleOptionsMetadata

An implementation of ModuleOptionsMetadata that derives its information from a plain old java object:

• public setters are reported as valid options
• the type of the option is derived from the accepted type by the setter

ModuleOptions for such a POJO will work as follows:

• an instance of the class will be created reflectively and injected with user provided values,
• reported properties are computed from all the getters,
• the POJO may bear JSR303 validation annotations, which will be used to validate the interpolated options,
• if the POJO implements ProfileNamesProvider, profile names will be gathered from a reflective call to ProfileNamesProvider.profilesToActivate()

Author:

Eric Bottard

Constructor Summary

Constructors

Constructor and Description
PojoModuleOptionsMetadata(java.lang.Class<?> clazz)
PojoModuleOptionsMetadata(java.lang.Class<?> clazz, org.springframework.core.io.ResourceLoader resourceLoader, org.springframework.core.env.Environment environment)

Method Summary

Methods

Modifier and Type	Method and Description
ModuleOptions	interpolate(java.util.Map<java.lang.String,java.lang.String> raw)
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

PojoModuleOptionsMetadata

public PojoModuleOptionsMetadata(java.lang.Class<?> clazz)

PojoModuleOptionsMetadata

public PojoModuleOptionsMetadata(java.lang.Class<?> clazz,
                         org.springframework.core.io.ResourceLoader resourceLoader,
                         org.springframework.core.env.Environment environment)

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

Specified by:

interpolate in interface ModuleOptionsMetadata

Throws:

org.springframework.validation.BindException