com.github.aschet.spdx.licensecompat.analysis.LicenseCompatAnalysisResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spdx-license-compat Show documentation

A license compatibility graph implementation for SPDX license identifiers.

The newest version!

/**
 * Copyright 2017 Thomas Ascher 
 * SPDX-License-Identifier: LGPL-3.0+
 */

package com.github.aschet.spdx.licensecompat.analysis;

import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;

import org.spdx.rdfparser.license.AnyLicenseInfo;

/**
 * The result of the license compatibility evaluation performed by
 * {@link LicenseCompatAnalysis}. A result contains the licenses which were part
 * of the compatibility test, the conflicts which resulted from the
 * compatibility test and the licenses which were not recognized by the
 * {@link LicenseCompatStrategy}.
 *
 * @author Thomas Ascher
 */
public class LicenseCompatAnalysisResult {

	/**
	 * List of conflicts between the tested licenses.
	 */
	private List conflicts = new ArrayList<>();

	/**
	 * Set of the tested licenses.
	 */
	private Set licenses = new LinkedHashSet<>();

	/**
	 * Set of the tested licenses which were not supported.
	 */
	private Set unsupportedLicenses = new LinkedHashSet<>();

	/**
	 * Get the conflicts between the tested licenses.
	 *
	 * @return conflicts as list of conjunctive SPDX expressions
	 */
	public List getConflicts() {
		return conflicts;
	}

	/**
	 * Get the tested licenses.
	 *
	 * @return licenses as SPDX identifiers
	 */
	public Set getLicenses() {
		return licenses;
	}

	/**
	 * Get the unrecognized licenses.
	 *
	 * @return licenses as SPDX identifiers
	 */
	public Set getUnsupportedLicenses() {
		return unsupportedLicenses;
	}

	/**
	 * Determines if the result has conflicts.
	 *
	 * @return true if the result has conflicts
	 */
	public boolean hasConflicts() {
		return getConflicts().size() > 0;
	}

	/**
	 * Determines if some of the tested licenses where not supported.
	 *
	 * @return true when unsupported licenses are present
	 */
	public boolean hasUnsupportedLicenses() {
		return getUnsupportedLicenses().size() > 0;
	}

	/**
	 * Set the conflicts between the tested licenses.
	 *
	 * @param conflicts
	 *            the conflicts between the licenses as conjunctive sets
	 */
	public void setConflicts(final List conflicts) {
		this.conflicts = conflicts;
	}

	/**
	 * Set the tested licenses.
	 *
	 * @param licenses
	 *            licenses as SPDX identifiers
	 */
	public void setLicenses(final Set licenses) {
		this.licenses = licenses;
	}

	/**
	 * Set the unrecognized licenses.
	 *
	 * @param unsupportedLicenses
	 *            licenses as SPDX identifiers
	 */
	public void setUnsupportedLicenses(final Set unsupportedLicenses) {
		this.unsupportedLicenses = unsupportedLicenses;
	}

	@Override
	public String toString() {
		final StringBuilder builder = new StringBuilder();
		builder.append("");
		return builder.toString();
	}

}