core/api/src/main/java/org/onosproject/net/newresource/AbstractResourceAllocation.java

/*
 * Copyright 2015 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.newresource;

import com.google.common.annotations.Beta;

import java.util.Objects;

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

/**
 * Base implementation of a class representing allocation of resource which belongs to a particular subject.
 *
 * @param <S> type of the subject
 * @param <T> type of the resource
 */
@Beta
public abstract class AbstractResourceAllocation<S, T> implements ResourceAllocation<S, T> {

    private final S subject;
    private final T resource;
    private final ResourceConsumer consumer;

    /**
     * Constructor expected to be called by constructors of the sub-classes.
     *
     * @param subject identifier which this resource belongs to
     * @param resource resource of the subject
     * @param consumer consumer ot this resource
     */
    protected AbstractResourceAllocation(S subject, T resource, ResourceConsumer consumer) {
        this.subject = checkNotNull(subject);
        this.resource = checkNotNull(resource);
        this.consumer = consumer;
    }

    @Override
    public S subject() {
        return subject;
    }

    @Override
    public T resource() {
        return resource;
    }

    @Override
    public ResourceConsumer consumer() {
        return consumer;
    }

    @Override
    public int hashCode() {
        return Objects.hash(subject, resource, consumer);
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof AbstractResourceAllocation)) {
            return false;
        }
        final AbstractResourceAllocation that = (AbstractResourceAllocation) obj;
        return Objects.equals(this.subject, that.subject)
                && Objects.equals(this.resource, that.resource)
                && Objects.equals(this.consumer, that.consumer);
    }
}