org.mule.runtime.api.meta.model.declaration.fluent

Class ParameterizedDeclarer<T extends ParameterizedDeclarer,D extends ParameterizedDeclaration>

java.lang.Object

org.mule.runtime.api.meta.model.declaration.fluent.Declarer<D>

org.mule.runtime.api.meta.model.declaration.fluent.ParameterizedDeclarer<T,D>

All Implemented Interfaces:

HasParametersDeclarer

Direct Known Subclasses:

ComponentDeclarer, ConfigurationDeclarer, ConnectionProviderDeclarer, FunctionDeclarer, SourceCallbackDeclarer

public abstract class ParameterizedDeclarer<T extends ParameterizedDeclarer,D extends ParameterizedDeclaration>
extends Declarer<D>
implements HasParametersDeclarer

Base class for a declarer which allows adding ParameterDeclarations

Since:

1.0

Field Summary

Fields inherited from class org.mule.runtime.api.meta.model.declaration.fluent.Declarer

declaration

Constructor Summary

Constructors

Constructor and Description
ParameterizedDeclarer(D declaration)

Method Summary

Modifier and Type	Method and Description
T	describedAs(String description) Adds a description
ParameterGroupDeclarer	onDefaultParameterGroup() Provides the default ParameterGroupDeclarer.
ParameterGroupDeclarer	onParameterGroup(String name) Provides a ParameterGroupDeclarer for adding parameters into a group of the given name.

Methods inherited from class org.mule.runtime.api.meta.model.declaration.fluent.Declarer

getDeclaration

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterizedDeclarer

public ParameterizedDeclarer(D declaration)

Method Detail

onParameterGroup

public ParameterGroupDeclarer onParameterGroup(String name)

Provides a ParameterGroupDeclarer for adding parameters into a group of the given name. Use this if you wish to declare a parameter which should belong to a specific group.

Specified by:

onParameterGroup in interface HasParametersDeclarer

Parameters:

name - the name of the group to declare

Returns:

a ParameterGroupDeclarer

onDefaultParameterGroup

public ParameterGroupDeclarer onDefaultParameterGroup()

Provides the default ParameterGroupDeclarer. Use this if you wish to add a parameter which shouldn't belong to any specific group.

Specified by:

onDefaultParameterGroup in interface HasParametersDeclarer

Returns:

a ParameterGroupDeclarer

describedAs

public T describedAs(String description)

Adds a description

Parameters:

description - a description

Returns:

this declarer