core/api/src/main/java/org/onosproject/net/intent/constraint/MarkerConstraint.java

/*
 * Copyright 2016-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.intent.constraint;

import org.onosproject.net.Link;
import org.onosproject.net.Path;
import org.onosproject.net.intent.Constraint;
import org.onosproject.net.intent.ResourceContext;

/**
 * Abstract Constraint for constraints not intended to influence
 * individual link cost or path validity.
 */
public abstract class MarkerConstraint implements Constraint {

    @Override
    public final double cost(Link link, ResourceContext context) {
        // random value, should never be used.
        return 1.0;
    }

    @Override
    public final boolean validate(Path path, ResourceContext context) {
        return true;
    }

    @Override
    public int hashCode() {
        return this.getClass().hashCode();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        return obj != null && this.getClass() == obj.getClass();
    }

    @Override
    public String toString() {
        return getClass().getSimpleName().replace("Constraint", "");
    }
}