AnalyzedCode.java

package de.is24.deadcode4j;

import javax.annotation.Nonnull;
import java.util.EnumSet;
import java.util.Map;
import java.util.Set;

/**
 * <code>AnalyzedCode</code> comprises the classes being analyzed as well as the code dependencies.
 *
 * @since 1.0.0
 */
public class AnalyzedCode {
    @Nonnull
    private final EnumSet<AnalysisStage> stagesWithExceptions;
    @Nonnull
    private final Set<String> analyzedClasses;
    @Nonnull
    private final Map<String, Set<String>> codeDependencies;

    public AnalyzedCode(@Nonnull EnumSet<AnalysisStage> stagesWithExceptions,
                        @Nonnull Set<String> analyzedClasses,
                        @Nonnull Map<String, Set<String>> codeDependencies) {
        this.stagesWithExceptions = stagesWithExceptions;
        this.analyzedClasses = analyzedClasses;
        this.codeDependencies = codeDependencies;
    }

    @Nonnull
    public Set<String> getAnalyzedClasses() {
        return analyzedClasses;
    }

    /**
     * Returns a map consisting of code artifacts (typically classes) pointing to their dependencies.
     */
    @Nonnull
    public Map<String, Set<String>> getCodeDependencies() {
        return codeDependencies;
    }

    /**
     * Returns the stages for which an exception occurred.
     *
     * @since 2.0.0
     */
    @Nonnull
    public EnumSet<AnalysisStage> getStagesWithExceptions() {
        return stagesWithExceptions;
    }

}