pcap/org.eclipse.tracecompass.pcap.core/src/org/eclipse/tracecompass/internal/pcap/core/protocol/ethernet2/EthernetIIEndpoint.java

/*******************************************************************************
 * Copyright (c) 2014 Ericsson
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License 2.0 which
 * accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *   Vincent Perot - Initial API and implementation
 *******************************************************************************/

package org.eclipse.tracecompass.internal.pcap.core.protocol.ethernet2;

import java.util.Arrays;

import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.tracecompass.internal.pcap.core.endpoint.ProtocolEndpoint;
import org.eclipse.tracecompass.internal.pcap.core.util.ConversionHelper;

/**
 * Class that extends the {@link ProtocolEndpoint} class. It represents the
 * endpoint at an Ethernet II level.
 *
 * @author Vincent Perot
 */
public class EthernetIIEndpoint extends ProtocolEndpoint {

    private final byte[] fMacAddress;

    /**
     * Constructor of the {@link EthernetIIEndpoint} class. It takes a packet to
     * get its endpoint. Since every packet has two endpoints (source and
     * destination), the isSourceEndpoint parameter is used to specify which
     * endpoint to take.
     *
     * @param packet
     *            The packet that contains the endpoints.
     * @param isSourceEndpoint
     *            Whether to take the source or the destination endpoint of the
     *            packet.
     */
    public EthernetIIEndpoint(EthernetIIPacket packet, boolean isSourceEndpoint) {
        super(packet, isSourceEndpoint);
        fMacAddress = isSourceEndpoint ? packet.getSourceMacAddress() : packet.getDestinationMacAddress();
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        ProtocolEndpoint endpoint = getParentEndpoint();
        if (endpoint == null) {
            result = 0;
        } else {
            result = endpoint.hashCode();
        }
        result = prime * result + Arrays.hashCode(fMacAddress);
        return result;
    }

    @Override
    public boolean equals(@Nullable Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof EthernetIIEndpoint)) {
            return false;
        }

        EthernetIIEndpoint other = (EthernetIIEndpoint) obj;

        // Check on layer
        boolean localEquals = Arrays.equals(fMacAddress, other.fMacAddress);
        if (!localEquals) {
            return false;
        }

        // Check above layers.
        ProtocolEndpoint endpoint = getParentEndpoint();
        if (endpoint != null) {
            return endpoint.equals(other.getParentEndpoint());
        }
        return true;
    }

    @Override
    public String toString() {
        ProtocolEndpoint endpoint = getParentEndpoint();
        if (endpoint == null) {
            return ConversionHelper.toMacAddress(fMacAddress);
        }
        return (endpoint.toString().equals(EMPTY_STRING) ?
                ConversionHelper.toMacAddress(fMacAddress) :
                endpoint.toString() + '/' + ConversionHelper.toMacAddress(fMacAddress));

    }
}