io.joynr.exceptions.MultiDomainNoCompatibleProviderFoundException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javaapi Show documentation
There is a newer version: 1.26.0
/*
 * #%L
 * %%
 * Copyright (C) 2011 - 2024 BMW Car IT GmbH
 * %%
 * 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.
 * #L%
 */
package io.joynr.exceptions;

import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import joynr.types.Version;

/**
 * This exception is thrown when a multi-domain proxy encounters {@link NoCompatibleProviderFoundException} for any of
 * the domains being queried. It contains a map from domain to the specific {@link NoCompatibleProviderFoundException}
 * information for that domain.
 */
public class MultiDomainNoCompatibleProviderFoundException extends DiscoveryException {

    /**
     * For serialization.
     */
    private static final long serialVersionUID = 1L;

    private final Map exceptionsByDomain;

    /**
     * Constructor which takes the map of domains to {@link NoCompatibleProviderFoundException}.
     *
     * @param exceptionsByDomain
     *            the exceptions keyed by domain.
     */
    public MultiDomainNoCompatibleProviderFoundException(Map exceptionsByDomain) {
        super("MultiDomainNoCompatibleProviderFoundException");
        this.exceptionsByDomain = (exceptionsByDomain != null) ? new HashMap<>(exceptionsByDomain) : null;
    }

    /**
     * Gets the map of domains to {@link NoCompatibleProviderFoundException}.
     *
     * @return see method description.
     */
    public Map getExceptionsByDomain() {
        return (exceptionsByDomain != null) ? new HashMap<>(exceptionsByDomain) : null;
    }

    /**
     * Gets a set of domains for which we have {@link NoCompatibleProviderFoundException} information available.
     *
     * @return see method description.
     */
    public Set getDomainsWithExceptions() {
        return exceptionsByDomain.keySet();
    }

    /**
     * Checks to see if information is available for a given domain.
     *
     * @param domain
     *            the domain to check for.
     *
     * @return true if there is information available for the domain in the form of a
     *         {@link #getExceptionForDomain(String) no compatible provider found exception} or false
     *         otherwise.
     */
    public boolean hasExceptionForDomain(String domain) {
        return exceptionsByDomain.containsKey(domain);
    }

    /**
     * Returns the {@link NoCompatibleProviderFoundException} for the given domain if one exists.
     *
     * @param domain
     *            the domain for which to get the {@link NoCompatibleProviderFoundException}.
     *
     * @return the exception if there is one, or null if not.
     */
    public NoCompatibleProviderFoundException getExceptionForDomain(String domain) {
        return exceptionsByDomain.get(domain);
    }

    /**
     * Returns the set of versions which were discovered for a given domain.
     *
     * @param domain
     *            the domain for which to return the set of versions which were found by that domain.
     *
     * @return the set of discovered versions for the given domain, or an empty set if no discovered versions are
     *         available for that domain. Will never be null.
     */
    public Set getDiscoveredVersionsForDomain(String domain) {
        Set result = new HashSet<>();
        if (hasExceptionForDomain(domain)) {
            result.addAll(exceptionsByDomain.get(domain).getDiscoveredVersions());
        }
        return result;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = super.hashCode();
        result = prime * result + ((exceptionsByDomain == null) ? 0 : exceptionsByDomain.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (!super.equals(obj))
            return false;
        if (getClass() != obj.getClass())
            return false;
        MultiDomainNoCompatibleProviderFoundException other = (MultiDomainNoCompatibleProviderFoundException) obj;
        if (exceptionsByDomain == null) {
            if (other.exceptionsByDomain != null)
                return false;
        } else if (!exceptionsByDomain.equals(other.exceptionsByDomain))
            return false;
        return true;
    }
}