org.mule.runtime.api.meta

Interface AnnotatedObject

All Known Subinterfaces:

ConfigurableObjectProvider, ExecutableComponent, ObjectProvider

All Known Implementing Classes:

AbstractAnnotatedObject

public interface AnnotatedObject

Maps annotations defined in an XML element to the corresponding Java object

Annotations are handled by the runtime and must not be tampered by custom implementations. The runtime will put values and remove values from the annotations and that behaviour should not be changed by any custom implementation.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_NAME

Method Summary

Modifier and Type	Method and Description
Object	getAnnotation(QName name) Gets the value of specified annotation.
Map<QName,Object>	getAnnotations() Gets all annotations.
ComponentLocation	getLocation()
String	getRootContainerName() The actual root container component name.
void	setAnnotations(Map<QName,Object> annotations) Sets annotations to the object.

Field Detail

PROPERTY_NAME

static final String PROPERTY_NAME

See Also:

Constant Field Values

Method Detail

getAnnotation

Object getAnnotation(QName name)

Gets the value of specified annotation.

Returns:

the value of specified annotation

getAnnotations

Map<QName,Object> getAnnotations()

Gets all annotations.

Returns:

all annotation

setAnnotations

void setAnnotations(Map<QName,Object> annotations)

Sets annotations to the object.

getLocation

ComponentLocation getLocation()

Returns:

the location properties of this component in the mule app configuration, or null if this object was generated programmatically and not from a configuration element.

getRootContainerName

String getRootContainerName()

The actual root container component name. Some components may belong to a template component in the configuration such as a subflow or a module operation. Since those are template that end up being part of another root container component, like a flow, then the root container name may differ from the one on ComponentLocation.getRootContainerName().

Returns:

the root container component name.