org.dsa.iot.dslink.node.value.ValuePair Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dslink Show documentation

SDK for the IoT DSA protocol

There is a newer version: 0.24.2

package org.dsa.iot.dslink.node.value;


import org.dsa.iot.dslink.node.NodeListener;

/**
 * Used for handling updates that involve a previous value.
 *
 * @author Samuel Grenier
 * @see NodeListener#setValueHandler
 */
public class ValuePair {

    private final boolean externalSource;
    private final Value previous;
    private Value current;
    private boolean reject;

    /**
     * @param previous Previous value.
     * @param current The new current value.
     * @param externalSource Whether the new value is being set from an
     *                       external source or not.
     */
    public ValuePair(Value previous, Value current, boolean externalSource) {
        this.previous = previous;
        this.current = current;
        this.externalSource = externalSource;
    }

    /**
     * @return Whether the new value came from an external source.
     */
    public boolean isFromExternalSource() {
        return externalSource;
    }

    /**
     * @return The previous, or old, value.
     */
    public Value getPrevious() {
        return previous;
    }

    /**
     * @return The current, or new, value.
     */
    public Value getCurrent() {
        return current;
    }

    /**
     * This allows for dynamic value control when being set from an external
     * source but the value is still valid and does not need to be rejected.
     *
     * @param value New value to set.
     */
    @SuppressWarnings("unused")
    public void setCurrent(Value value) {
        this.current = value;
    }

    /**
     * @param reject Whether to reject the new value or not.
     */
    @SuppressWarnings("unused")
    public void setReject(boolean reject) {
        this.reject = reject;
    }

    /**
     * @return Whether to reject the new value or not.
     */
    public boolean isRejected() {
        return reject;
    }
}