min-dev-java/src/main/java/component/MustBeRefresh.java

package component;

import encoding.*;

/*
 * @Author: Wang Feng
 * @Description: 表示内容兴趣包中的组件 MustBeRefresh
 * @Version: 1.0.0
 * @Date: 16:30 2021/3/9
 * @Copyright: MIN-Group；国家重大科技基础设施——未来网络北大实验室；深圳市信息论与未来网络重点实验室
 */
public class MustBeRefresh implements TlvComponentBase, InitialAble, IEncodingAble {
    // 成员变量
    private boolean mustBeRefresh;

    public MustBeRefresh(){
    }

    public MustBeRefresh(boolean mustBeRefresh){
        this.setMustBeRefresh(mustBeRefresh);
    }

    // 函数
    public boolean getMustBeRefresh() {
        return mustBeRefresh;
    }

    public void setMustBeRefresh(boolean mustBeRefresh) {
        this.mustBeRefresh = mustBeRefresh;
        this.doInitial();
    }

    // 接口实现-变量区
    private boolean initial = false;

    // 接口实现-方法区
    @Override
    public void doInitial() {
        initial = true;
    }

    @Override
    public boolean isInitial() {
        return initial;
    }

    /**
     * 将 MustBeRefresh 线速编码为一个 TLV
     *
     * @param encoder
     * @return
     */
    @Override
    public int wireEncode(Encoder encoder) throws ComponentException {
        try {
            // 这是一个存在性组件，所以如果值为false，则无需编码
            if (!this.mustBeRefresh) {
                return 0;
            }

            int totalLength = 0;

            // 编码 TLV-LENGTH
            int tmplen = encoder.prependVarNumber(new VlInt(totalLength));
            if (tmplen < 0) {
                return -1;
            }
            totalLength += tmplen;

            // 编码 TLV-TYPE
            tmplen = encoder.prependVarNumber(new VlInt(TLV.TlvMustBeRefresh));
            if (tmplen < 0) {
                return -1;
            }
            totalLength += tmplen;

            return totalLength;
        } catch (EncoderException e) {
            throw new ComponentException("MustBeRefresh.wireEncode: " + e.getMessage());
        }
    }

    /**
     * 从 TLV Block 中解码出一个 MustBeRefresh
     *
     * @param block
     * @return
     */
    @Override
    public boolean wireDecode(Block block) {
        // 检查 Type 是否正确
        if (!TLV.expectType(block.getType(), new VlInt(TLV.TlvMustBeRefresh))) {
            return false;
        }

        // 这是一个存在性组件，所以存在则为 true
        this.mustBeRefresh = true;
        this.doInitial();
        return true;
    }
}