org.kie.api.fluent.Variable Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2020 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.kie.api.fluent;

import java.util.HashMap;
import java.util.Map;

/** 
 * Builder pattern like class used to build a variable.

 * A variable requires a name and a data type.
 
 * Value and metadata are optional.
 
 * Usage:
 *  *  Variable.var("test",String.class)
 *          .value("example value")
 *          .metadata("readOnly",true).
 *          .metadata("required",false)
 * 
 *
 * @param  data type of the variable
 * @see NodeContainerBuilder#variable(Variable)
 */
public class Variable {
    
    private String name;
    private T value;
    private Class type;
    private Map metadata;

    private Variable(String name, Class type) {
        this.name = name;
        this.type = type;
    }
    
    public static  Variable var(String name, Class type) {
        return new Variable<>(name, type);
    }

    public Variable value(T value) {
        this.value = value;
        return this;
    }

    public Variable metadata(String key, Object value) {
        if (metadata == null) {
            metadata = new HashMap<>();
        }
        metadata.put(key, value);
        return this;
    }

    public String getName() {
        return name;
    }

    public T getValue() {
        return value;
    }

    public Class getType() {
        return type;
    }

    public Map getMetadata() {
        return metadata;
    }

    @Override
    public String toString() {
        return "Variable [name=" + name + ", value=" + value + ", type=" + type + ", metadata=" + metadata + "]";
    }
}