apps/segmentrouting/app/src/main/java/org/onosproject/segmentrouting/mcast/McastCacheKey.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.segmentrouting.mcast;

import org.onlab.packet.IpAddress;
import org.onosproject.net.ConnectPoint;
import org.onosproject.net.HostId;

import java.util.Objects;

import static com.google.common.base.MoreObjects.toStringHelper;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;

/**
 * Key of the multicast event cache.
 */
class McastCacheKey {
    // The group ip
    private final IpAddress mcastIp;
    // The sink id
    private final HostId sinkHost;
    // The sink connect point
    private final ConnectPoint sink;

    /**
     * Constructs a key for multicast event cache.
     *
     * @param mcastIp multicast group IP address
     * @param sink connect point of the sink
     *
     * @deprecated in 1.12 ("Magpie") release.
     */
    public McastCacheKey(IpAddress mcastIp, ConnectPoint sink) {
        checkNotNull(mcastIp, "mcastIp cannot be null");
        checkNotNull(sink, "sink cannot be null");
        checkArgument(mcastIp.isMulticast(), "mcastIp must be a multicast address");
        this.mcastIp = mcastIp;
        this.sink = sink;
        this.sinkHost = null;
    }

    /**
     * Constructs a key for multicast event cache.
     *
     * @param mcastIp multicast group IP address
     * @param hostId id of the sink
     */
    public McastCacheKey(IpAddress mcastIp, HostId hostId) {
        checkNotNull(mcastIp, "mcastIp cannot be null");
        checkNotNull(hostId, "sink cannot be null");
        checkArgument(mcastIp.isMulticast(), "mcastIp must be a multicast address");
        this.mcastIp = mcastIp;
        this.sinkHost = hostId;
        this.sink = null;
    }

    /**
     * Returns the multicast IP address of this key.
     *
     * @return multicast IP
     */
    public IpAddress mcastIp() {
        return mcastIp;
    }

    /**
     * Returns the sink of this key.
     *
     * @return connect point of the sink
     *
     * @deprecated in 1.12 ("Magpie") release.
     */
    public ConnectPoint sink() {
        return sink;
    }

    /**
     * Returns the sink of this key.
     *
     * @return host id of the sink
     */
    public HostId sinkHost() {
        return sinkHost;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof McastCacheKey)) {
            return false;
        }
        McastCacheKey that =
                (McastCacheKey) o;
        return (Objects.equals(this.mcastIp, that.mcastIp) &&
                Objects.equals(this.sink, that.sink) &&
                Objects.equals(this.sinkHost, that.sinkHost));
    }

    @Override
    public int hashCode() {
         return Objects.hash(mcastIp, sink);
    }

    @Override
    public String toString() {
        return toStringHelper(getClass())
                .add("mcastIp", mcastIp)
                .add("sink", sink)
                .add("sinkHost", sinkHost)
                .toString();
    }
}