com.oracle.bedrock.matchers.EntrySetMatcher Maven / Gradle / Ivy

Go to download
/*
 * File: EntrySetMatcher.java
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * The contents of this file are subject to the terms and conditions of
 * the Common Development and Distribution License 1.0 (the "License").
 *
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the License by consulting the LICENSE.txt file
 * distributed with this file, or by consulting https://oss.oracle.com/licenses/CDDL
 *
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file LICENSE.txt.
 *
 * MODIFICATIONS:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 */

package com.oracle.bedrock.matchers;

import org.hamcrest.Description;
import org.hamcrest.Factory;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeMatcher;

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

/**
 * A Hamcrest-based {@link TypeSafeMatcher} for {@link Set}s of {@link Map.Entry}s.
 * 
 * Copyright (c) 2016. All Rights Reserved. Oracle Corporation.

 * Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
 *
 * @author Brian Oliver
 */
public class EntrySetMatcher extends TypeSafeMatcher>>
{
    /**
     * The {@link Map} to which comparison will occur.
     */
    private Map map;

    /**
     * The {@link Equivalence} function for the values.
     */
    private Equivalence valueEquivalence;


    /**
     * Constructs a {@link EntrySetMatcher}.
     *
     * @param entries  the {@link Set} of {@link Map.Entry}s to compare with
     */
    private EntrySetMatcher(Set> entries,
                            Equivalence       valueEquivalence)
    {
        this.map              = mapOf(entries);
        this.valueEquivalence = valueEquivalence == null ? Equivalence.EQUALS : valueEquivalence;
    }


    /**
     * Obtains a {@link Map} representation of a {@link Set} of {@link Map.Entry}s.
     *
     * @param entries  the {@link Set} of {@link Map.Entry}s
     *
     * @return a {@link Map}
     */
    private Map mapOf(Set> entries)
    {
        if (entries == null)
        {
            return null;
        }
        else
        {
            HashMap map = new HashMap<>();

            for (Iterator> iterator = entries.iterator(); iterator.hasNext(); )
            {
                Map.Entry entry = iterator.next();

                map.put(entry.getKey(), entry.getValue());
            }

            return map;
        }
    }


    @Override
    public boolean matchesSafely(Set> entries)
    {
        Map        otherMap = mapOf(entries);

        MapMatcher matcher  = (MapMatcher) MapMatcher.sameAs(map, valueEquivalence);

        return matcher.matchesSafely(otherMap);
    }


    @Override
    public void describeMismatchSafely(Set> entries,
                                       Description          mismatchDescription)
    {
        MapMatcher matcher = (MapMatcher) MapMatcher.sameAs(map, valueEquivalence);

        matcher.describeMismatchSafely(mapOf(entries), mismatchDescription);
    }


    @Override
    public void describeTo(Description description)
    {
        MapMatcher matcher = (MapMatcher) MapMatcher.sameAs(map, valueEquivalence);

        matcher.describeTo(description);
    }


    @Factory
    public static  Matcher>> sameAs(Set> entries,
                                                              Equivalence       equivalence)
    {
        return new EntrySetMatcher(entries, equivalence);
    }


    @Factory
    public static  Matcher> sameAs(Set> entries)
    {
        return sameAs(entries, Equivalence.EQUALS);
    }
}