core/store/dist/src/main/java/org/onosproject/store/resource/impl/DiscreteResources.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.store.resource.impl;

import com.google.common.base.MoreObjects;
import com.google.common.collect.Sets;
import org.onosproject.net.resource.DiscreteResource;
import org.onosproject.net.resource.DiscreteResourceId;
import org.onosproject.net.resource.Resources;

import java.util.LinkedHashSet;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;

final class DiscreteResources {
    private final Set<DiscreteResource> values;

    static DiscreteResources empty() {
        return new DiscreteResources();
    }

    private DiscreteResources() {
        this.values = new LinkedHashSet<>();
    }

    DiscreteResources(List<DiscreteResource> values) {
        this.values = new LinkedHashSet<>(values);
    }

    private DiscreteResources(Set<DiscreteResource> values) {
        this.values = values;
    }

    Optional<DiscreteResource> lookup(DiscreteResourceId id) {
        DiscreteResource resource = Resources.discrete(id).resource();
        if (values.contains(resource)) {
            return Optional.of(resource);
        } else {
            return Optional.empty();
        }
    }

    DiscreteResources difference(DiscreteResources other) {
        return new DiscreteResources(Sets.difference(this.values, other.values));
    }

    boolean isEmpty() {
        return values.isEmpty();
    }

    boolean containsAny(List<DiscreteResource> other) {
        return other.stream().anyMatch(values::contains);
    }

    // returns a new instance, not mutate the current instance
    DiscreteResources add(DiscreteResources other) {
        Set<DiscreteResource> newValues = new LinkedHashSet<>(this.values);
        newValues.addAll(other.values);
        return new DiscreteResources(newValues);
    }

    // returns a new instance, not mutate the current instance
    DiscreteResources remove(List<DiscreteResource> removed) {
        Set<DiscreteResource> newValues = new LinkedHashSet<>(this.values);
        newValues.removeAll(removed);
        return new DiscreteResources(newValues);
    }

    Set<DiscreteResource> values() {
        // breaks immutability, but intentionally returns the field
        // because this class is transient
        return values;
    }

    @Override
    public int hashCode() {
        return Objects.hash(values);
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null || getClass() != obj.getClass()) {
            return false;
        }
        final DiscreteResources other = (DiscreteResources) obj;
        return Objects.equals(this.values, other.values);
    }

    @Override
    public String toString() {
        return MoreObjects.toStringHelper(this)
                .add("values", values)
                .toString();
    }
}