org.mutabilitydetector.AnalysisResult 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;

import static java.util.Arrays.asList;
import static org.mutabilitydetector.IAnalysisSession.IsImmutable.DEFINITELY;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;

import org.mutabilitydetector.IAnalysisSession.IsImmutable;

public final class AnalysisResult {
	public final String dottedClassName;
	public final IsImmutable isImmutable;
	public final Collection reasons;
	
	
	public AnalysisResult(String dottedClassName, IsImmutable isImmutable, Collection reasons) {
		check(isImmutable, reasons);
		this.dottedClassName = dottedClassName;
		this.isImmutable = isImmutable;
		this.reasons = Collections.unmodifiableCollection(new ArrayList(reasons));
	}
	
	private void check(IsImmutable isImmutable, Collection reasons) {
		if(isImmutable != DEFINITELY && reasons.isEmpty()) {
			throw new IllegalArgumentException("Reasons must be given when a class is not DEFINITELY immutable.");
		}
	}

	public AnalysisResult(String dottedClassName, IsImmutable isImmutable, CheckerReasonDetail... reasons) {
		this(dottedClassName, isImmutable, asList(reasons));
	}
	
	public static AnalysisResult definitelyImmutable(String dottedClassName) {
		return new AnalysisResult(dottedClassName, IsImmutable.DEFINITELY);
	}
}