core/api/src/main/java/org/onosproject/net/flow/ExtensionTreatmentCodec.java

/*
 * Copyright 2017-present Open Networking Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.onosproject.net.flow;

import com.fasterxml.jackson.databind.node.ObjectNode;
import org.onosproject.codec.CodecContext;
import org.onosproject.net.driver.HandlerBehaviour;
import org.onosproject.net.flow.instructions.ExtensionTreatment;

/**
 * Interface for encode and decode extension treatment.
 */
public interface ExtensionTreatmentCodec extends HandlerBehaviour {

    /**
     * Encodes an extension treatment to an JSON object.
     *
     * @param extensionTreatment extension treatment
     * @param  context encoding context
     * @return JSON object
     */
    default ObjectNode encode(ExtensionTreatment extensionTreatment, CodecContext context) {
        return null;
    }

    /**
     * Decodes an JSON object to an extension treatment.
     *
     * @param objectNode JSON object
     * @param  context decoding context
     * @return extension treatment
     */
    default ExtensionTreatment decode(ObjectNode objectNode, CodecContext context) {
        return null;
    }
}