org.mule.runtime.api.ioc

Interface ObjectProvider

All Superinterfaces:

Component

All Known Subinterfaces:

ConfigurableObjectProvider

public interface ObjectProvider
extends Component

Interface meant to be implemented by components that will provide objects that may be referenced from mule configuration files.

Since:

1.0

Nested Class Summary

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

Component.Annotations

Field Summary

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

ANNOTATIONS_PROPERTY_NAME, NS_MULE_DOCUMENTATION, NS_MULE_PARSER_METADATA

Method Summary

Modifier and Type	Method and Description
boolean	containsObject(String name)
Optional<Object>	getObject(String name) Finds an object by name
Optional<Object>	getObjectByType(Class<?> objectType) Finds an object by type
<T> Map<String,T>	getObjectsByType(Class<T> type) Finds all objects matching the given type
Optional<Boolean>	isObjectSingleton(String name)

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

getAnnotation, getAnnotations, getDslSource, getIdentifier, getLocation, getRepresentation, getRootContainerLocation, setAnnotations

Method Detail

getObject

Optional<Object> getObject(String name)

Finds an object by name

Parameters:

name - the object name

Returns:

the object if there's one, empty otherwise.

getObjectByType

Optional<Object> getObjectByType(Class<?> objectType)

Finds an object by type

Parameters:

objectType - the object type.

Returns:

the object if there's one, empty otherwise. In case there are many, then it will fail unless there's a preferred one. How the preferred one is defined is up to the ObjectProvider implementation.

getObjectsByType

<T> Map<String,T> getObjectsByType(Class<T> type)

Finds all objects matching the given type

Type Parameters:

T - type parameter for the object

Parameters:

type - the object type class object

Returns:

a map where the keys are the object names and the values the objects associated with the key

isObjectSingleton

Optional<Boolean> isObjectSingleton(String name)

Parameters:

name - object name

Returns:

true if the object is a singleton, false if it's not, empty if there's no an object with that name.

containsObject

boolean containsObject(String name)

Parameters:

name - object name

Returns:

true if the provider contains a bean with such name, false otherwise.