org.jtrim2.taskgraph.TaskNodeCreateArgs Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jtrim-task-graph Show documentation
JTrim Task Graph
There is a newer version: 2.0.7
package org.jtrim2.taskgraph;

import java.util.Objects;

/**
 * Defines the properties used to create a task node. Instances of this
 * class are passed to task node factories.
 *
 * Thread safety
 * Although methods of this class are safely accessible from multiple threads concurrently,
 * the returned properties are not.
 *
 * Synchronization transparency
 * The methods of this class are synchronization transparent.
 *
 * @param  the return type of the task node to be created
 * @param  the type of the argument passed to the task node factory when requested for
 *   a node to be created
 *
 * @see TaskFactory
 */
public final class TaskNodeCreateArgs {
    private final TaskNodeKey nodeKey;
    private final TaskInputBinder inputs;
    private final TaskNodeProperties.Builder properties;

    /**
     * Creates a new {@code TaskNodeCreateArgs} with the given properties.
     *
     * @param nodeKey the {@code TaskNodeKey} identifying the node to be created. This argument
     *   cannot be {@code null}.
     * @param defaults the default values for the {@link #properties() node properties}.
     *   This argument cannot be {@code null}.
     * @param inputs the {@code TaskInputBinder} used to bind inputs for the created
     *   task node function. This argument cannot be {@code null}.
     */
    public TaskNodeCreateArgs(TaskNodeKey nodeKey, TaskNodeProperties defaults, TaskInputBinder inputs) {
        Objects.requireNonNull(inputs, "inputs");

        this.nodeKey = Objects.requireNonNull(nodeKey, "nodeKey");
        this.inputs = Objects.requireNonNull(inputs, "inputs");
        this.properties = new TaskNodeProperties.Builder(defaults);
    }

    /**
     * Returns the key uniquely identifying the task node to be created.
     *
     * @return the key uniquely identifying the task node to be created.
     *   This method never returns {@code null}.
     */
    public TaskNodeKey nodeKey() {
        return nodeKey;
    }

    /**
     * Returns the argument passed to the task node factory. This argument
     * with the {@link TaskFactoryKey task node factory key} uniquely identify
     * a task node.
     *
     * @return the argument passed to the task node factory. This method may return
     *   {@code null}, if {@code null} was specified for the factory.
     */
    public I factoryArg() {
        return nodeKey.getFactoryArg();
    }

    /**
     * Returns the {@code TaskInputBinder} used to bind inputs for the created
     * task node function.
     *
     * @return the {@code TaskInputBinder} used to bind inputs for the created
     *   task node function. This method never returns {@code null}.
     */
    public TaskInputBinder inputs() {
        return inputs;
    }

    /**
     * Returns the properties to be set for the associated task node to be created.
     *
     * @return the properties to be set for the associated task node to be created.
     *   This method may never return {@code null}.
     */
    public TaskNodeProperties.Builder properties() {
        return properties;
    }
}