org.mule.runtime.config.internal

Interface OptionalObjectsController

All Known Implementing Classes:

CompositeOptionalObjectsController, DefaultOptionalObjectsController

public interface OptionalObjectsController

Keeps track of keys that have been marked as optional on a registry-bootstrap file. It also tracks the optional keys that couldn't in fact be instantiated and are discarded

Since:

3.7.0

Method Summary

Modifier and Type	Method and Description
void	discardOptionalObject(String key) Registers the given key as a discarded object
Collection<String>	getAllOptionalKeys()
Object	getDiscardedObjectPlaceholder() A placeholder for Spring to temporarily work with.
boolean	isDiscarded(String key)
boolean	isOptional(String key)
void	registerOptionalKey(String key) Registers the given key as optional

Method Detail

registerOptionalKey

void registerOptionalKey(String key)

Registers the given key as optional

Parameters:

key - an object key

discardOptionalObject

void discardOptionalObject(String key)

Registers the given key as a discarded object

Parameters:

key - an object key

isOptional

boolean isOptional(String key)

Parameters:

key - an object key

Returns:

true if the given key is optional. false otherwise

isDiscarded

boolean isDiscarded(String key)

Parameters:

key - an object key

Returns:

true if the given key is discarded. false otherwise

getDiscardedObjectPlaceholder

Object getDiscardedObjectPlaceholder()

A placeholder for Spring to temporarily work with. This is because Spring can't handle null entries. This object will be removed from the registry when MuleArtifactContext is fully started

Returns:

a generic object

getAllOptionalKeys

Collection<String> getAllOptionalKeys()

Returns:

an immutable view of all the current optional keys