core/api/src/main/java/org/onosproject/net/flow/criteria/TcpPortCriterion.java

/*
 * Copyright 2015-present Open Networking Laboratory
 *
 * 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.net.flow.criteria;

import org.onlab.packet.TpPort;

import java.util.Objects;

/**
 * Implementation of TCP port criterion (16 bits unsigned integer).
 */
public final class TcpPortCriterion implements Criterion {
    private final TpPort tcpPort;
    private final TpPort mask;
    private final Type type;

    /**
     * Constructor.
     *
     * @param tcpPort the TCP port to match
     * @param mask the mask for the TCP port
     * @param type the match type. Should be either Type.TCP_SRC_MASKED or
     * Type.TCP_DST_MASKED
     */
    TcpPortCriterion(TpPort tcpPort, TpPort mask, Type type) {
        this.tcpPort = tcpPort;
        this.mask = mask;
        this.type = type;
    }

    /**
     * Constructor.
     *
     * @param tcpPort the TCP port to match
     * @param type the match type. Should be either Type.TCP_SRC or
     * Type.TCP_DST
     */
    TcpPortCriterion(TpPort tcpPort, Type type) {
        this(tcpPort, null, type);
    }

    @Override
    public Type type() {
        return this.type;
    }

    /**
     * Gets the TCP port to match.
     *
     * @return the TCP port to match
     */
    public TpPort tcpPort() {
        return this.tcpPort;
    }

    /**
     * Gets the mask for the TCP port to match.
     *
     * @return the TCP port mask, null if not specified
     */
    public TpPort mask() {
        return this.mask;
    }

    @Override
    public String toString() {
        return (mask != null) ?
                type().toString() + SEPARATOR + tcpPort + "/" + mask :
                type().toString() + SEPARATOR + tcpPort;
    }

    @Override
    public int hashCode() {
        return Objects.hash(type.ordinal(), tcpPort, mask);
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj instanceof TcpPortCriterion) {
            TcpPortCriterion that = (TcpPortCriterion) obj;
            return Objects.equals(tcpPort, that.tcpPort) &&
                    Objects.equals(mask, that.mask) &&
                    Objects.equals(type, that.type);
        }
        return false;
    }
}