core/api/src/main/java/org/onosproject/net/pi/runtime/PiTernaryFieldMatch.java

/*
 * Copyright 2017-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.net.pi.runtime;

import com.google.common.annotations.Beta;
import com.google.common.base.Objects;
import org.onlab.util.ImmutableByteSequence;
import org.onosproject.net.pi.model.PiMatchType;

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

/**
 * Ternary field match in a protocol-independent pipeline.
 */
@Beta
public final class PiTernaryFieldMatch extends PiFieldMatch {

    private final ImmutableByteSequence value;
    private final ImmutableByteSequence mask;

    /**
     * Creates a new ternary field match.
     *
     * @param fieldId field identifier
     * @param value value
     * @param mask  mask
     */
    public PiTernaryFieldMatch(PiHeaderFieldId fieldId, ImmutableByteSequence value,
                               ImmutableByteSequence mask) {
        super(fieldId);
        this.value = checkNotNull(value);
        this.mask = checkNotNull(mask);
        checkArgument(value.size() == mask.size() && value.size() > 0,
                      "Value and mask must have same non-zero size");
    }

    @Override
    public PiMatchType type() {
        return PiMatchType.TERNARY;
    }

    /**
     * Returns the value matched by this field.
     *
     * @return an immutable byte sequence
     */
    public ImmutableByteSequence value() {
        return value;
    }

    /**
     * Returns the mask used to match this field.
     *
     * @return an immutable byte sequence
     */
    public ImmutableByteSequence mask() {
        return mask;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        PiTernaryFieldMatch that = (PiTernaryFieldMatch) o;
        return Objects.equal(this.fieldId(), that.fieldId()) &&
                Objects.equal(value, that.value) &&
                Objects.equal(mask, that.mask);
    }

    @Override
    public int hashCode() {
        return Objects.hashCode(this.fieldId(), value, mask);
    }

    @Override
    public String toString() {
        return this.fieldId().toString() + '=' + value.toString() + "&&&" + mask.toString();
    }
}