apps/odtn/api/src/main/java/org/onosproject/odtn/utils/openconfig/OpenConfigChannelHandler.java

/*
 * Copyright 2018-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.odtn.utils.openconfig;

import org.onosproject.yang.gen.v1.openconfigterminaldevice.rev20161222.openconfigterminaldevice.terminallogicalchanneltop.logicalchannels.DefaultChannel;

import org.onosproject.yang.model.KeyLeaf;

/**
 * Utility class to deal with OPENCONFIG Channel ModelObject & Annotation.
 */
public final class OpenConfigChannelHandler
        extends OpenConfigObjectHandler<DefaultChannel> {

    private static final String OPENCONFIG_NAME = "channel";
    private static final String KEY_LEAF_NAME = "index";
    private static final String NAME_SPACE = "http://openconfig.net/yang/terminal-device";

    /**
     * OpenConfigChannelHandler Constructor.
     *
     * @param keyValue String of target OPENCONFIG's key
     * @param parent OpenConfigLogicalChannelsHandler of parent OPENCONFIG(logical-channels)
     */
    public OpenConfigChannelHandler(String keyValue, OpenConfigLogicalChannelsHandler parent) {
        modelObject = new DefaultChannel();
        modelObject.index(keyValue);
        setResourceId(OPENCONFIG_NAME, NAME_SPACE,
                      new KeyLeaf(KEY_LEAF_NAME, NAME_SPACE, keyValue),
                      parent.getResourceIdBuilder());
        annotatedNodeInfos = parent.getAnnotatedNodeInfoList();

        parent.addChannel(this);
    }

    /**
     * Add Config to modelObject of target OPENCONFIG.
     *
     * @param config OpenConfigConfigOfChannelHandler having Config to be set for modelObject
     * @return OpenConfigChannelHandler of target OPENCONFIG
     */
    public OpenConfigChannelHandler addConfig(OpenConfigConfigOfChannelHandler config) {
        modelObject.config(config.getModelObject());
        return this;
    }

    /**
     * Add LogicalChannelAssignments to modelObject of target OPENCONFIG.
     *
     * @param logicalChannelAssignments OpenConfigLogicalChannelAssignmentsHandler having
     *                                  LogicalChannelAssignments to be set for modelObject
     * @return OpenConfigChannelHandler of target OPENCONFIG
     */
    public OpenConfigChannelHandler addLogicalChannelAssignments(
           OpenConfigLogicalChannelAssignmentsHandler logicalChannelAssignments) {
        modelObject.logicalChannelAssignments(logicalChannelAssignments.getModelObject());
        return this;
    }
}