org.opendaylight.netide.netiplib.ErrorMessage Maven / Gradle / Ivy

Go to download

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

Java Library for handling the NetIDE intermediate protocol.

There is a newer version: 0.3.4-Carbon

/*
 * Copyright (c) 2015 NetIDE Consortium and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.netide.netiplib;

import java.util.ArrayList;
import java.util.List;
import org.javatuples.Pair;

/**
 * Class representing a message of type ERROR.
 * Note that this only serves as a convenience class - if the MessageType is manipulated, the class will not recognize that.
 */
public class ErrorMessage extends Message {
    /**
     * The list of supported protocols and their versions.
     */
    private List> supportedProtocols;

    /**
     * Instantiates a new Error message.
     */
    public ErrorMessage() {
        super(new MessageHeader(), new byte[0]);
        header.setMessageType(MessageType.ERROR);
        supportedProtocols = new ArrayList<>();
    }

    /**
     * Gets supported protocols.
     *
     * @return the supported protocols
     */
    public List> getSupportedProtocols() {
        return supportedProtocols;
    }

    /**
     * Sets supported protocols.
     *
     * @param supportedProtocols the supported protocols
     */
    public void setSupportedProtocols(List> supportedProtocols) {
        this.supportedProtocols = supportedProtocols;
    }

    @Override
    public byte[] getPayload() {
        byte[] payload = new byte[supportedProtocols.size() * 2];
        int i = 0;
        for (Pair entry : supportedProtocols) {
            payload[i] = entry.getValue0().getValue();
            payload[i + 1] = entry.getValue1().getValue();
            i += 2;
        }
        this.payload = payload;
        return this.payload;
    }
}