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

Class BaseDeclaration<T extends BaseDeclaration>

java.lang.Object

org.mule.runtime.api.meta.model.declaration.fluent.BaseDeclaration<T>

Type Parameters:

T - the concrete type for this declaration

All Implemented Interfaces:

DescribedObject

Direct Known Subclasses:

NamedDeclaration, OutputDeclaration

public abstract class BaseDeclaration<T extends BaseDeclaration>
extends Object
implements DescribedObject

Base class for a declaration object.

By default, getDescription() returns an empty String.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
BaseDeclaration()

Method Summary

Modifier and Type	Method and Description
T	addModelProperty(ModelProperty modelProperty) Adds the given .
String	getDescription() Returns the component's description
DisplayModel	getDisplayModel()
Set<ModelProperty>	getModelProperties() Returns a Set with the currently added properties.
<P extends ModelProperty> Optional<P>	getModelProperty(Class<P> propertyType) Returns the model property registered under key
void	setDescription(String description) Sets the description for this declaration
void	setDisplayModel(DisplayModel displayModel) Sets the displayModel for this declaration

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseDeclaration

public BaseDeclaration()

Method Detail

getModelProperties

public Set<ModelProperty> getModelProperties()

Returns a Set with the currently added properties. Notice that this Set is mutable and not thread-safe.

This method is to be used when you need to access all the properties. For individual access use addModelProperty(ModelProperty)} or getModelProperty(Class) instead

Returns:

a Set with the current model properties. Might be empty but will never by null

getModelProperty

public <P extends ModelProperty> Optional<P> getModelProperty(Class<P> propertyType)

Returns the model property registered under key

Type Parameters:

P - the generic type for the response value

Parameters:

propertyType - the property's Class

Returns:

the associated value wrapped on an Optional

addModelProperty

public T addModelProperty(ModelProperty modelProperty)

Adds the given . If a property of the same Class has already been added, it will be overwritten.

Parameters:

modelProperty - a ModelProperty

Throws:

IllegalArgumentException - if modelProperty is null{}

getDescription

public String getDescription()

Returns the component's description

Specified by:

getDescription in interface DescribedObject

Returns:

a non blank String

setDescription

public void setDescription(String description)

Sets the description for this declaration

Parameters:

description -

getDisplayModel

public DisplayModel getDisplayModel()

Returns:

The DisplayModel for this declaration

setDisplayModel

public void setDisplayModel(DisplayModel displayModel)

Sets the displayModel for this declaration

Parameters:

displayModel - a DisplayModel