org.mule.extension.introspection.declaration.fluent

Class ParameterDescriptor<T extends ParameterDescriptor>

java.lang.Object

org.mule.extension.introspection.declaration.fluent.ParameterDescriptor<T>

All Implemented Interfaces:

Descriptor, HasCapabilities<ParameterDescriptor<T>>

Direct Known Subclasses:

OptionalParameterDescriptor

public class ParameterDescriptor<T extends ParameterDescriptor>
extends Object
implements Descriptor, HasCapabilities<ParameterDescriptor<T>>

A Descriptor which allows configuring a ParameterDeclaration through a fluent API

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
T	describedAs(String description) Adds a description
ParameterDeclaration	getDeclaration() Gets the declaration object for this descriptor
DeclarationDescriptor	getRootDeclaration() Returns the root element of this declaration
T	ofType(Class<?> type, Class<?>... parametrizedTypes) Specifies the type of the Parameter and its parametrized types
T	ofType(DataType dataType) Specifies the type of the Parameter
T	whichIsDynamic() Specifies that the declared Parameter is to be dynamic (which is the default anyways...)
T	whichIsStatic() Specifies that the declared Parameter is not to be dynamic
WithParameters	with()
ParameterDescriptor<T>	withCapability(Object capability) Adds the given capability to the declaring parameter
ConfigurationDescriptor	withConfig(String name) Adds another config of the given name
OperationDescriptor	withOperation(String name) Adds another operation of the given name

Methods inherited from class java.lang.Object

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

Method Detail

ofType

public T ofType(Class<?> type,
       Class<?>... parametrizedTypes)

Specifies the type of the Parameter and its parametrized types

Parameters:

type - the type of the parameter

parametrizedTypes - the generic types for type

Returns:

descriptor

ofType

public T ofType(DataType dataType)

Specifies the type of the Parameter

Parameters:

dataType - the type of the parameter

Returns:

describedAs

public T describedAs(String description)

Adds a description

Parameters:

description - a description

Returns:

descriptor

whichIsStatic

public T whichIsStatic()

Specifies that the declared Parameter is not to be dynamic

Returns:

descriptor

whichIsDynamic

public T whichIsDynamic()

Specifies that the declared Parameter is to be dynamic (which is the default anyways...)

Returns:

descriptor

withConfig

public ConfigurationDescriptor withConfig(String name)

Adds another config of the given name

Parameters:

name - the name of the config

Returns:

a new ConfigurationDescriptor

withOperation

public OperationDescriptor withOperation(String name)

Adds another operation of the given name

Parameters:

name - the name of the config

Returns:

a new OperationDescriptor

with

public WithParameters with()

Returns:

a WithParameters that allows adding more parameters to the owning Descriptor

getRootDeclaration

public DeclarationDescriptor getRootDeclaration()

Description copied from interface: Descriptor

Returns the root element of this declaration

Specified by:

getRootDeclaration in interface Descriptor

Returns:

the root DeclarationDescriptor

withCapability

public ParameterDescriptor<T> withCapability(Object capability)

Adds the given capability to the declaring parameter

Specified by:

withCapability in interface HasCapabilities<ParameterDescriptor<T extends ParameterDescriptor>>

Parameters:

capability - a not null capability

Returns:

descriptor

getDeclaration

public ParameterDeclaration getDeclaration()

Gets the declaration object for this descriptor

Returns:

a ParameterDeclaration