/*
 * Copyright (c) 2015 Cisco Systems, Inc. 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.protocol.bgp.rib.spi;

import com.google.common.collect.ImmutableList;
import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpAddPathTableType;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.peer.SupportedTablesKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.SubsequentAddressFamily;
import org.opendaylight.yangtools.util.ImmutableOffsetMapTemplate;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;

public final class RibSupportUtils {
    private static final ImmutableOffsetMapTemplate<QName> AFI_SAFI_TEMPLATE =
            ImmutableOffsetMapTemplate.ordered(ImmutableList.of(QName.create(Tables.QNAME, "afi").intern(),
                QName.create(Tables.QNAME, "safi").intern()));

    private static final ImmutableOffsetMapTemplate<QName> ADD_PATH_AFI_SAFI_TEMPLATE =
            ImmutableOffsetMapTemplate.ordered(ImmutableList.of(QName.create(BgpAddPathTableType.QNAME, "afi").intern(),
                QName.create(BgpAddPathTableType.QNAME, "safi").intern()));

    private RibSupportUtils() {
        // Hidden on purpose
    }

    /**
     * Creates Yang Instance Identifier path argument from supplied AFI and SAFI.
     *
     * @param afi  Class representing AFI
     * @param safi Class representing SAFI
     * @return NodeIdentifierWithPredicates of {@link Tables} for specified AFI, SAFI combination.
     */
    public static NodeIdentifierWithPredicates toYangTablesKey(final Class<? extends AddressFamily> afi,
            final Class<? extends SubsequentAddressFamily> safi) {
        return toYangKey(Tables.QNAME, afi, safi);
    }

    /**
     * Creates Yang Instance Identifier path argument from supplied AFI and SAFI.
     *
     * @param id   QNAME representing node
     * @param afi  Class representing AFI
     * @param safi Class representing SAFI
     * @return NodeIdentifierWithPredicates of 'id' for specified AFI, SAFI combination.
     */
    public static NodeIdentifierWithPredicates toYangKey(final QName id, final Class<? extends AddressFamily> afi,
            final Class<? extends SubsequentAddressFamily> safi) {
        return NodeIdentifierWithPredicates.of(id, AFI_SAFI_TEMPLATE.instantiateWithValues(
            BindingReflections.findQName(afi), BindingReflections.findQName(safi)));
    }

    /**
     * Creates Yang Instance Identifier path argument from supplied AFI and SAFI.
     *
     * @param id   QNAME representing node
     * @param afi  Class representing AFI
     * @param safi Class representing SAFI
     * @return NodeIdentifierWithPredicates of 'id' for specified AFI, SAFI combination.
     */
    public static NodeIdentifierWithPredicates toYangPathKey(final QName id, final Class<? extends AddressFamily> afi,
            final Class<? extends SubsequentAddressFamily> safi) {
        return NodeIdentifierWithPredicates.of(id, ADD_PATH_AFI_SAFI_TEMPLATE.instantiateWithValues(
            BindingReflections.findQName(afi), BindingReflections.findQName(safi)));
    }

    /**
     * Creates Yang Instance Identifier path argument from supplied {@link TablesKey}.
     *
     * @param id QNAME representing node
     * @param tablesKey  Tables key representing table.
     * @return NodeIdentifierWithPredicates of 'id' for specified AFI, SAFI combination.
     */
    @SuppressWarnings("checkstyle:OverloadMethodsDeclarationOrder")
    public static NodeIdentifierWithPredicates toYangKey(final QName id, final TablesKey tablesKey) {
        return toYangKey(id, tablesKey.getAfi(), tablesKey.getSafi());
    }

    /**
     * Creates Yang Instance Identifier path argument from supplied {@link TablesKey}.
     *
     * @param id QNAME representing node
     * @param tablesKey  Add PAth Tables key representing table.
     * @return NodeIdentifierWithPredicates of 'id' for specified AFI, SAFI combination.
     */
    public static NodeIdentifierWithPredicates toYangKey(final QName id, final SupportedTablesKey tablesKey) {
        return toYangPathKey(id, tablesKey.getAfi(), tablesKey.getSafi());
    }

    /**
     * Creates Yang Instance Identifier path argument from supplied {@link TablesKey}.
     *
     * @param tablesKey Tables key representing table.
     * @return NodeIdentifierWithPredicates of {@link Tables} for specified AFI, SAFI combination.
     */
    @SuppressWarnings("checkstyle:OverloadMethodsDeclarationOrder")
    public static NodeIdentifierWithPredicates toYangTablesKey(final TablesKey tablesKey) {
        return toYangTablesKey(tablesKey.getAfi(), tablesKey.getSafi());
    }
}