io.github.linuxforhealth.api.EvaluationResult Maven / Gradle / Ivy

/*
 * (C) Copyright IBM Corp. 2020, 2021
 *
 * SPDX-License-Identifier: Apache-2.0
 */
package io.github.linuxforhealth.api;

import java.util.List;

/**
 * Represents value returned after the expression is evaluated.
 * 
 *
 * @author pbhallam
 */
public interface EvaluationResult {

    /**
     * Value generated after the evaluation or an resource or an expression
     * 
     * @param  The value to be evaluated
     * 
     * @return V The returned value
     */
     V getValue();

    /**
     * Get name/identifier for the return value;
     * 
     * @return String
     */
    String getIdentifier();

    /**
     * Class type of the value
     * 
     * @return Class type of the value
     */
    Class getValueType();

    /**
     * If the value is empty return true.
     * 
     * @return True if the value is null or empty
     */
    boolean isEmpty();

    /**
     * Additional resources generated during evaluation or an resource or an expression
     * 
     * @return List of {@link ResourceValue}
     */
    List getAdditionalResources();

}