org.mule.metadata.api.model

Interface ObjectKeyType

All Superinterfaces:

MetadataType

All Known Implementing Classes:

DefaultObjectKeyType

public interface ObjectKeyType
extends MetadataType

Represents an object key. It contains the name or pattern and the attributes.

Method Summary

Modifier and Type	Method and Description
Collection<AttributeFieldType>	getAttributes() All the attributes of this key
QName	getName() The name of the key if it is a named key else throws a NoSuchElementException.
Pattern	getPattern() The pattern of the key if it is a pattern based key else throws a NoSuchElementException.
boolean	isName() Return if the this is a named key or not
boolean	isPattern() Return if the this is a pattern key or not.

Methods inherited from interface org.mule.metadata.api.model.MetadataType

accept, getAnnotation, getAnnotations, getDescription, getMetadataFormat

Method Detail

getName

QName getName()

The name of the key if it is a named key else throws a NoSuchElementException.

Returns:

The name of the key.

Throws:

NoSuchElementException - if it is not a named key.

isName

boolean isName()

Return if the this is a named key or not

Returns:

True if it is a named key

getPattern

Pattern getPattern()

The pattern of the key if it is a pattern based key else throws a NoSuchElementException.

Returns:

The name of the key.

Throws:

NoSuchElementException - if it is not a pattern based key.

isPattern

boolean isPattern()

Return if the this is a pattern key or not.

Returns:

True if it is a pattern key

getAttributes

Collection<AttributeFieldType> getAttributes()

All the attributes of this key

Returns:

The collection with the attributes