incubator/api/src/main/java/org/onosproject/incubator/net/virtual/DefaultVirtualPort.java

/*
 * Copyright 2016-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.incubator.net.virtual;

import org.onosproject.net.ConnectPoint;
import org.onosproject.net.DefaultAnnotations;
import org.onosproject.net.DefaultPort;
import org.onosproject.net.Device;
import org.onosproject.net.Element;
import org.onosproject.net.PortNumber;

import java.util.Objects;

import static com.google.common.base.MoreObjects.toStringHelper;

/**
 * Default representation of a virtual port.
 */
public final class DefaultVirtualPort extends DefaultPort implements VirtualPort {

    private final NetworkId networkId;
    private final ConnectPoint realizedBy;

    /**
     * Creates a virtual port.
     *
     * @param networkId  network identifier
     * @param device     parent network element
     * @param portNumber port number
     * @param realizedBy underling port which realizes this virtual port
     */
    public DefaultVirtualPort(NetworkId networkId, Device device, PortNumber portNumber,
                              ConnectPoint realizedBy) {
        this(networkId, device, portNumber, false, realizedBy);
    }

    /**
     * Creates a virtual port.
     *
     * @param networkId  network identifier
     * @param device     parent network element
     * @param portNumber port number
     * @param isEnabled  indicator whether the port is up and active
     * @param realizedBy underling port which realizes this virtual port
     */
    public DefaultVirtualPort(NetworkId networkId, Device device, PortNumber portNumber,
                              boolean isEnabled, ConnectPoint realizedBy) {
        super((Element) device, portNumber, isEnabled, DefaultAnnotations.builder().build());
        this.networkId = networkId;
        this.realizedBy = realizedBy;
    }

    /**
     * Returns network identifier.
     *
     * @return network identifier
     */
    public NetworkId networkId() {
        return networkId;
    }

    @Override
    public ConnectPoint realizedBy() {
        return realizedBy;
    }

    @Override
    public int hashCode() {
        return Objects.hash(networkId, realizedBy);
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj instanceof DefaultVirtualPort) {
            DefaultVirtualPort that = (DefaultVirtualPort) obj;
            return super.equals(that) &&
                    Objects.equals(this.networkId, that.networkId) &&
                    Objects.equals(this.number(), that.number()) &&
                    Objects.equals(this.realizedBy, that.realizedBy);
        }
        return false;
    }

    @Override
    public String toString() {
        return toStringHelper(this).add("networkId", networkId).add("realizedBy", realizedBy).toString();
    }

}