org.mule.common.metadata
Interface MetaDataKey

All Superinterfaces:

Comparable<MetaDataKey>

All Known Implementing Classes:

DefaultMetaDataKey

public interface MetaDataKey
extends Comparable<MetaDataKey>

This represent a service entity/type. The Id is the XML identifier name for the entity, Display Name is used for Studio UI for improve the user experience, and Category (despite not being shown by Studio UI) is mandatory for grouping types. Properties are used for advanced scenarios like grouping entities/types or DSQL.

Shouldn't implement this interface as it can change and break compatibility. Instead please use the DefaultMetaDataKey implementation.

Method Summary

boolean	addProperty(MetaDataKeyProperty metaDataKeyProperty)
String	getCategory()
String	getDisplayName()
String	getId()
List<MetaDataKeyProperty>	getProperties()
<T extends MetaDataKeyProperty> T	getProperty(Class<T> metaDataKeyProperty)
boolean	hasProperty(Class<? extends MetaDataKeyProperty> metaDataKeyProperty)
boolean	removeProperty(MetaDataKeyProperty metaDataKeyProperty)

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getId

String getId()

getDisplayName

String getDisplayName()

getCategory

String getCategory()

getProperties

List<MetaDataKeyProperty> getProperties()

addProperty

boolean addProperty(MetaDataKeyProperty metaDataKeyProperty)

removeProperty

boolean removeProperty(MetaDataKeyProperty metaDataKeyProperty)

hasProperty

boolean hasProperty(Class<? extends MetaDataKeyProperty> metaDataKeyProperty)

getProperty

<T extends MetaDataKeyProperty> T getProperty(Class<T> metaDataKeyProperty)