org.mule.devkit.internal.metadata

Class DefaultComposedMetaDataKey

java.lang.Object

org.mule.devkit.internal.metadata.DefaultComposedMetaDataKey

All Implemented Interfaces:

Comparable<org.mule.common.metadata.MetaDataKey>, org.mule.common.metadata.MetaDataKey, org.mule.common.metadata.TypeMetaDataModel, ComposedMetaDataKey

public class DefaultComposedMetaDataKey
extends Object
implements ComposedMetaDataKey, org.mule.common.metadata.TypeMetaDataModel

MetaDataKey default implementation. This should be used to describe the service entities/types names and display name.

Author:

Mulesoft, Inc

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_KEY_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
DefaultComposedMetaDataKey() Basic constructor, default separator will be used if none is provided when id's are fetched.
DefaultComposedMetaDataKey(ComposedMetaDataKey origin) Copy constructor.
DefaultComposedMetaDataKey(org.mule.common.metadata.MetaDataKey defaultKey, String separator) Creates a ComposedMetaDataKey from a simple MetaDataKey.
DefaultComposedMetaDataKey(String separator) Custom separator constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLevel(String levelId, String label) Creates a new level in the current key with this id.
boolean	addProperty(org.mule.common.metadata.key.property.MetaDataKeyProperty metaDataKeyProperty)
int	compareTo(org.mule.common.metadata.MetaDataKey otherMetadataKey) For keys comparison, the first criteria to match will be the category of both keys, where, if it's not possible to discriminate the order, the key id will take place.
boolean	equals(Object obj)
String	getCategory()
String	getDisplayName() This will return a single string representation of the key labels, appending each level label with a the default separator @link{DefaultComposedMetaDataKey.DEFAULT_KEY_SEPARATOR}.
String	getDisplayName(String separator) This will return a single string representation of the key labels, appending each level label with the parameterized separator.
String	getId() This will return a single string representation of the key id's, appending each level id with a the default separator @link{DefaultComposedMetaDataKey.DEFAULT_KEY_SEPARATOR}.
String	getId(String separator) This will return a single string representation of the key labels, appending each level label with the parameterized separator.
List<org.mule.common.metadata.key.property.MetaDataKeyProperty>	getProperties()
<T extends org.mule.common.metadata.key.property.MetaDataKeyProperty> T	getProperty(Class<T> metaDataKeyProperty)
String	getSeparator()
List<String>	getSortedDisplayNames()
List<String>	getSortedIds()
int	hashCode()
boolean	hasProperty(Class<? extends org.mule.common.metadata.key.property.MetaDataKeyProperty> metaDataKeyProperty)
boolean	isFromCapable() Deprecated. use hasProperty(Class) instead
Integer	levels()
boolean	removeProperty(org.mule.common.metadata.key.property.MetaDataKeyProperty metaDataKeyProperty)
void	setCategory(String category)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_KEY_SEPARATOR

public static final String DEFAULT_KEY_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

DefaultComposedMetaDataKey

public DefaultComposedMetaDataKey()

Basic constructor, default separator will be used if none is provided when id's are fetched.

DefaultComposedMetaDataKey

public DefaultComposedMetaDataKey(String separator)

Custom separator constructor. This separator will act as default for this key.

Throws:

InvalidSeparatorException

DefaultComposedMetaDataKey

public DefaultComposedMetaDataKey(ComposedMetaDataKey origin)

Copy constructor. Both keys will preserve the same properties references

DefaultComposedMetaDataKey

public DefaultComposedMetaDataKey(org.mule.common.metadata.MetaDataKey defaultKey,
                          String separator)

Creates a ComposedMetaDataKey from a simple MetaDataKey. Using the separator, the key will be split in different levels of the new ComposedMetaDataKey.

Parameters:

separator - KeySeparator for

Throws:

InvalidKeyException

Method Detail

addLevel

public void addLevel(String levelId,
            String label)

Creates a new level in the current key with this id.

Specified by:

addLevel in interface ComposedMetaDataKey

Throws:

InvalidKeyException

getId

public String getId()

This will return a single string representation of the key id's, appending each level id with a the default separator @link{DefaultComposedMetaDataKey.DEFAULT_KEY_SEPARATOR}.

Specified by:

getId in interface org.mule.common.metadata.MetaDataKey

levels

public Integer levels()

Specified by:

levels in interface ComposedMetaDataKey

getSeparator

public String getSeparator()

Specified by:

getSeparator in interface ComposedMetaDataKey

getDisplayName

public String getDisplayName()

This will return a single string representation of the key labels, appending each level label with a the default separator @link{DefaultComposedMetaDataKey.DEFAULT_KEY_SEPARATOR}.

Specified by:

getDisplayName in interface org.mule.common.metadata.MetaDataKey

getId

public String getId(String separator)

This will return a single string representation of the key labels, appending each level label with the parameterized separator.

Specified by:

getId in interface ComposedMetaDataKey

Parameters:

separator - string used as division between ids

getDisplayName

public String getDisplayName(String separator)

This will return a single string representation of the key labels, appending each level label with the parameterized separator.

Specified by:

getDisplayName in interface ComposedMetaDataKey

Parameters:

separator - string used as division between labels

getSortedIds

public List<String> getSortedIds()

Specified by:

getSortedIds in interface ComposedMetaDataKey

getSortedDisplayNames

public List<String> getSortedDisplayNames()

Specified by:

getSortedDisplayNames in interface ComposedMetaDataKey

getCategory

public String getCategory()

Specified by:

getCategory in interface org.mule.common.metadata.MetaDataKey

setCategory

public void setCategory(String category)

getProperties

public List<org.mule.common.metadata.key.property.MetaDataKeyProperty> getProperties()

Specified by:

getProperties in interface org.mule.common.metadata.MetaDataKey

addProperty

public boolean addProperty(org.mule.common.metadata.key.property.MetaDataKeyProperty metaDataKeyProperty)

Specified by:

addProperty in interface org.mule.common.metadata.MetaDataKey

removeProperty

public boolean removeProperty(org.mule.common.metadata.key.property.MetaDataKeyProperty metaDataKeyProperty)

Specified by:

removeProperty in interface org.mule.common.metadata.MetaDataKey

hasProperty

public boolean hasProperty(Class<? extends org.mule.common.metadata.key.property.MetaDataKeyProperty> metaDataKeyProperty)

Specified by:

hasProperty in interface org.mule.common.metadata.MetaDataKey

getProperty

public <T extends org.mule.common.metadata.key.property.MetaDataKeyProperty> T getProperty(Class<T> metaDataKeyProperty)

Specified by:

getProperty in interface org.mule.common.metadata.MetaDataKey

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(org.mule.common.metadata.MetaDataKey otherMetadataKey)

For keys comparison, the first criteria to match will be the category of both keys, where, if it's not possible to discriminate the order, the key id will take place.

Specified by:

compareTo in interface Comparable<org.mule.common.metadata.MetaDataKey>

Parameters:

otherMetadataKey - the key to be compared with

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

isFromCapable

@Deprecated
public boolean isFromCapable()

Deprecated. use hasProperty(Class) instead

Specified by:

isFromCapable in interface org.mule.common.metadata.TypeMetaDataModel