Module org.mule.runtime.extensions.api

Package org.mule.runtime.extension.api.property

Class MetadataKeyIdModelProperty

java.lang.Object

org.mule.runtime.extension.api.property.MetadataKeyIdModelProperty

All Implemented Interfaces:

Serializable, org.mule.runtime.api.meta.model.ModelProperty, org.mule.runtime.api.meta.NamedObject

public final class MetadataKeyIdModelProperty
extends Object
implements org.mule.runtime.api.meta.model.ModelProperty

A ModelProperty for a of SourceModel and OperationModel parameters that indicates that its a MetadataKeyId.

Since:

1.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
MetadataKeyIdModelProperty(org.mule.metadata.api.model.MetadataType type, String parameterName)	Deprecated.
MetadataKeyIdModelProperty(org.mule.metadata.api.model.MetadataType type, String parameterName, String categoryName)

Method Summary

Modifier and Type	Method	Description
Optional<String>	getCategoryName()
String	getName()
String	getParameterName()
org.mule.metadata.api.model.MetadataType	getType()
boolean	isPublic()

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

MetadataKeyIdModelProperty

@Deprecated
public MetadataKeyIdModelProperty(org.mule.metadata.api.model.MetadataType type,
 String parameterName)

Deprecated.

Creates a new instance.

Parameters:

type - of the ParameterModel annotated with MetadataKeyId.

MetadataKeyIdModelProperty

public MetadataKeyIdModelProperty(org.mule.metadata.api.model.MetadataType type,
 String parameterName,
 String categoryName)

Method Details

getName

public String getName()

Specified by:

getName in interface org.mule.runtime.api.meta.model.ModelProperty

Specified by:

getName in interface org.mule.runtime.api.meta.NamedObject

isPublic

public boolean isPublic()

Specified by:

isPublic in interface org.mule.runtime.api.meta.model.ModelProperty

getType

public org.mule.metadata.api.model.MetadataType getType()

Returns:

the type of the ParameterModel annotated with MetadataKeyId

getParameterName

public String getParameterName()

Returns:

the parameter name that is considered as the MetadataKeyId

getCategoryName

public Optional<String> getCategoryName()

Returns:

The category name where the current MetadataKeyId belongs.