org.somda.sdc.biceps.common.access.WriteStateResult Maven / Gradle / Ivy

Go to download

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

SDCri is a set of Java libraries that implements a network communication framework conforming with the IEEE 11073 SDC specifications. This project implements the functionality described in IEEE 11073-10207.

There is a newer version: 5.1.1

Show newest version

package org.somda.sdc.biceps.common.access;

import org.somda.sdc.biceps.model.participant.AbstractState;
import org.somda.sdc.biceps.model.participant.MdibVersion;
import org.somda.sdc.common.util.ObjectStringifier;
import org.somda.sdc.common.util.Stringified;

import java.util.List;

/**
 * Read-only result set of a write states call.
 */
public class WriteStateResult {
    @Stringified
    private final MdibVersion mdibVersion;
    private final List states;

    /**
     * Constructor to initialize all values of the result set.
     *
     * @param mdibVersion the MDIB version.
     * @param states      all updated states.
     */
    public WriteStateResult(MdibVersion mdibVersion,
                            List states) {
        this.mdibVersion = mdibVersion;
        this.states = states;
    }

    /**
     * Gets the MDIB version that ensued during the preceding write operation.
     *
     * @return the MDIB version.
     */
    public MdibVersion getMdibVersion() {
        return mdibVersion;
    }

    /**
     * Gets all updated states.
     *
     * @return the states.
     */
    public List getStates() {
        return states;
    }

    @Override
    public String toString() {
        return ObjectStringifier.stringify(this);
    }
}