com.mulesoft.amf.loader

Class ExtensionLoader

java.lang.Object

com.mulesoft.amf.loader.ExtensionLoader

public class ExtensionLoader
extends Object

This is the entry point for a mini-framework designed to help loading data from AMF annotations/extensions.

The vendor extension starting point is defined over an existing API-contract component (e.g. operation). To add your own extension to that class you create an interface that contains a getter for that property. That method must be annotated with @AMFProperty, to supply the IRI of that property.

The type of the getter can be a primitive (like String). However, it can also be a mapping. To support mappings you would return a POJO that has been annotated with @AMFMapping. This POJO will have its constructor called with the values in the mapping. For this to work each of the constructor parameters must be annotated with @AMFProperty. These parameters can be mapping as well, and they will be recursively processed.

Constructor Summary

Constructors

Constructor and Description
ExtensionLoader(Class<?>... mappingClasses)
ExtensionLoader(@NotNull List<Class<?>> mappingClasses)

Method Summary

Modifier and Type	Method and Description
<T> T	extend(@NotNull amf.core.client.platform.model.domain.Graph graph, @NotNull Class<T> extenderInterface) Enables accessing vendor extensions.
@NotNull Object	loadMapping(@NotNull amf.aml.client.platform.model.domain.DialectDomainElement element) Loads an AML mapping into an object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtensionLoader

public ExtensionLoader(@NotNull
                       Class<?>... mappingClasses)

ExtensionLoader

public ExtensionLoader(@NotNull
                       @NotNull List<Class<?>> mappingClasses)

Method Detail

extend

@Contract(pure=true)
 @NotNull
public <T> T extend(@NotNull
                                                   @NotNull amf.core.client.platform.model.domain.Graph graph,
                                                   @NotNull
                                                   @NotNull Class<T> extenderInterface)

Enables accessing vendor extensions.

This function returns an instance of the passed interface that allows you to get extension properties from an AMF graph. The passed interface must have methods annotated with @AMFProperty to define those properties.

Parameters:

graph - an AMF graph with extension properties

extenderInterface - an interface with annotated methods

Returns:

an instance of extenderInterface

loadMapping

@NotNull
public @NotNull Object loadMapping(@NotNull
                                            @NotNull amf.aml.client.platform.model.domain.DialectDomainElement element)

Loads an AML mapping into an object.

The mapping class is selected according to the passed element intrinsic type, as defined by its DialectDomainElement.getTypeIris() method.

Parameters:

element - the source element

Returns:

the loaded mapping