org.mutabilitydetector.unittesting.ProvidedOtherClass Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of MutabilityDetector Show documentation

Lightweight analysis tool for detecting mutability in Java classes.

There is a newer version: 0.10.6

/*
 * Mutability Detector
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 *
 * Further licensing information for this project can be found in 
 * 		license/LICENSE.txt
 */

package org.mutabilitydetector.unittesting;

import java.util.Collection;
import java.util.HashSet;
import java.util.Set;

import org.hamcrest.Description;
import org.mutabilitydetector.AnalysisResult;
import org.mutabilitydetector.CheckerReasonDetail;
import org.mutabilitydetector.locations.Dotted;
import org.mutabilitydetector.unittesting.matchers.AllowedIfOtherClassIsImmutable;
import org.mutabilitydetector.unittesting.matchers.AllowedReasonCollector;
import org.mutabilitydetector.unittesting.matchers.BaseAnalysisResultMatcher;

public class ProvidedOtherClass extends BaseAnalysisResultMatcher {

	private final Dotted dottedClassName;
	private final Set allowedReasonCollectors = new HashSet();

	public ProvidedOtherClass(Dotted dottedClassName) {
		this.dottedClassName = dottedClassName;
	}


	public ProvidedOtherClass isAlsoImmutable() {
		AllowedIfOtherClassIsImmutable allowed = new AllowedIfOtherClassIsImmutable(dottedClassName);
		allowedReasonCollectors.add(allowed);
		return this;
	}


	@Override protected boolean matchesSafely(AnalysisResult analysisResult, Description mismatchDescription) {
		Collection allowedReasons = new HashSet();
		for(AllowedReasonCollector collector: allowedReasonCollectors) {
			allowedReasons.addAll(collector.allowedReasons(analysisResult));
		}
		
		Collection actualReasons = new HashSet(analysisResult.reasons);
		
		actualReasons.removeAll(allowedReasons);
		return  (actualReasons.size() == 0);
	}

	@Override public void describeTo(Description description) {
		throw new UnsupportedOperationException("Not yet implemented.");
	}
}