org.mule.runtime.api.component

Class AbstractComponent

java.lang.Object

org.mule.runtime.api.component.AbstractComponent

All Implemented Interfaces:

Component

Direct Known Subclasses:

PoolingProfile

public abstract class AbstractComponent
extends Object
implements Component

Base implementation for Component

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.api.component.Component

Component.Annotations

Field Summary

Fields

Modifier and Type	Field and Description
static QName	ANNOTATION_NAME
static QName	LOCATION_KEY
static QName	ROOT_CONTAINER_NAME_KEY

Fields inherited from interface org.mule.runtime.api.component.Component

ANNOTATIONS_PROPERTY_NAME, NS_MULE_DOCUMENTATION, NS_MULE_PARSER_METADATA

Constructor Summary

Constructors

Constructor and Description
AbstractComponent()

Method Summary

Modifier and Type	Method and Description
Object	getAnnotation(QName qName) Gets the value of specified annotation.
Map<QName,Object>	getAnnotations() Gets all annotations.
String	getDslSource()
ComponentIdentifier	getIdentifier()
ComponentLocation	getLocation()
String	getRepresentation()
Location	getRootContainerLocation() The actual root container component location.
protected Location	initRootContainerName()
void	setAnnotations(Map<QName,Object> newAnnotations) Sets annotations to the object.

Methods inherited from class java.lang.Object

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

Field Detail

LOCATION_KEY

public static final QName LOCATION_KEY

ROOT_CONTAINER_NAME_KEY

public static final QName ROOT_CONTAINER_NAME_KEY

ANNOTATION_NAME

public static final QName ANNOTATION_NAME

Constructor Detail

AbstractComponent

public AbstractComponent()

Method Detail

getAnnotation

public Object getAnnotation(QName qName)

Description copied from interface: Component

Gets the value of specified annotation.

Specified by:

getAnnotation in interface Component

Returns:

the value of specified annotation

getAnnotations

public Map<QName,Object> getAnnotations()

Description copied from interface: Component

Gets all annotations.

Specified by:

getAnnotations in interface Component

Returns:

all annotation

setAnnotations

public void setAnnotations(Map<QName,Object> newAnnotations)

Description copied from interface: Component

Sets annotations to the object.

Specified by:

setAnnotations in interface Component

initRootContainerName

protected Location initRootContainerName()

getLocation

public ComponentLocation getLocation()

Specified by:

getLocation in interface Component

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.

getRootContainerLocation

public Location getRootContainerLocation()

Description copied from interface: Component

The actual root container component location. 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 may differ from the one on ComponentLocation#getRootContainerLocation().

Specified by:

getRootContainerLocation in interface Component

Returns:

the root container component location.

getIdentifier

public ComponentIdentifier getIdentifier()

Specified by:

getIdentifier in interface Component

Returns:

the type identifier for this component.

getRepresentation

public String getRepresentation()

Specified by:

getRepresentation in interface Component

Returns:

a representation of a flow element to be logged in a standard way.

getDslSource

public String getDslSource()

Specified by:

getDslSource in interface Component

Returns:

the source code of this element in the DSL.