org.mule.module.extension.internal.runtime.ObjectBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mule-module-extensions-support Show documentation

Default implementation of the Mule Extension API.

There is a newer version: 3.9.0

Show newest version

/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.module.extension.internal.runtime;

import org.mule.api.MuleEvent;
import org.mule.api.MuleException;
import org.mule.module.extension.internal.runtime.resolver.ValueResolver;

import java.lang.reflect.Field;

/**
 * A builder capable of creating instances of a
 * given {@link Class}, populating its attributes
 * based on a list of {@link ValueResolver}s.
 * 
 * The built object's class must comply with the following
 * requirements:
 * 

 * 

 * It must be a concrete class
 * 
It must have a public, default constructor
 * It must have a standard setter for each property that
 * this builder will be populating
 * 
 * 
 * Instances of this class are to be considered thread safe and
 * reusable since the {@link #build(MuleEvent)} method can be invoked
 * several times on the same instance. Each time {@link #build(MuleEvent)}
 * is invoked, the resolvers will be re evaluated with the given event.
 *
 * @since 3.7.0
 */
public interface ObjectBuilder
{

    /**
     * Adds a property which value is to be obtained from
     * a {@link ValueResolver}
     *
     * @param field   the {@link Field} in which the value is to be assigned
     * @param resolver a {@link ValueResolver} used to provide the actual value
     * @return this builder
     * @throws {@link java.lang.IllegalArgumentException} if method or resolver are {@code null}
     */
    ObjectBuilder addPropertyResolver(Field field, ValueResolver resolver);

    /**
     * Whether any of the registered {@link ValueResolver}s are dynamic
     *
     * @return {@code true} if at least one resolver is dynamic. {@code false} otherwise
     */
    boolean isDynamic();

    /**
     * Returns a new instance of the specified class.
     * The given {@link MuleEvent} will be used to obtain a
     * value from each registered {@link ValueResolver}
     *
     * @param event a {@link MuleEvent}
     * @return a new instance
     * @throws {@link MuleException}
     */
    T build(MuleEvent event) throws MuleException;
}