org.mule.runtime.module.artifact.api.plugin

Class LoaderDescriber

java.lang.Object

org.mule.runtime.module.artifact.api.plugin.LoaderDescriber

@NoInstantiate
 @NoExtend
public class LoaderDescriber
extends Object

Generic descriptor that will be used to describe parameterization to construct ExtensionModel, ClassLoader and any other descriptor that may arise in a future of ArtifactPluginDescriptor.

Each LoaderDescriber will have an ID that will be used to discover any loader that's responsible of working with the current set of attributes. It's up to each loader to validate the types, size and all that matters around the attributes.

Since:

4.5

Constructor Summary

Constructors

Constructor and Description
LoaderDescriber(String id) Creates an immutable implementation of LoaderDescriber

Method Summary

Modifier and Type	Method and Description
void	addAttributes(Map<String,Object> attributes) Stores all the entries of attributes under in the attributes internal state.
Map<String,Object>	getAttributes()
String	getId()

Methods inherited from class java.lang.Object

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

Constructor Detail

LoaderDescriber

public LoaderDescriber(String id)

Creates an immutable implementation of LoaderDescriber

Parameters:

id - ID of the descriptor. Not blank nor null.

Method Detail

getId

public String getId()

Returns:

descriptor's ID that will be used to discover any object that matches with this ID.

getAttributes

public Map<String,Object> getAttributes()

Returns:

attributes that will be feed to the loader found through getId(), where it's up to the loader's responsibilities to determine if the current structure of the values (Object) does match with the expected types.

That implies each loader must evaluate on the attributes' values to be 100% sure it were formed correctly.

addAttributes

public void addAttributes(Map<String,Object> attributes)

Stores all the entries of attributes under in the attributes internal state.

Parameters:

attributes - mappings to be stored in this map