// Copyright 2014 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.devtools.build.lib.analysis;

import com.google.common.collect.ImmutableSortedSet;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import java.util.Objects;
import java.util.Set;

/** Contains options which control the set of artifacts to build for top-level targets. */
@Immutable
public final class TopLevelArtifactContext {
  private final boolean runTestsExclusively;
  private final boolean expandFilesets;
  private final boolean fullyResolveFilesetSymlinks;
  private final ImmutableSortedSet<String> outputGroups;

  public TopLevelArtifactContext(
      boolean runTestsExclusively,
      boolean expandFilesets,
      boolean fullyResolveFilesetSymlinks,
      ImmutableSortedSet<String> outputGroups) {
    this.runTestsExclusively = runTestsExclusively;
    this.expandFilesets = expandFilesets;
    this.fullyResolveFilesetSymlinks = fullyResolveFilesetSymlinks;
    this.outputGroups = outputGroups;
  }

  /** Whether to run tests in exclusive mode. */
  public boolean runTestsExclusively() {
    return runTestsExclusively;
  }

  public boolean expandFilesets() {
    return expandFilesets;
  }

  public boolean fullyResolveFilesetSymlinks() {
    return fullyResolveFilesetSymlinks;
  }

  /** Returns the value of the --output_groups flag. */
  public Set<String> outputGroups() {
    return outputGroups;
  }


  // TopLevelArtifactContexts are stored in maps in BuildView,
  // so equals() and hashCode() need to work.
  @Override
  public boolean equals(Object other) {
    if (other instanceof TopLevelArtifactContext) {
      TopLevelArtifactContext otherContext = (TopLevelArtifactContext) other;
      return runTestsExclusively == otherContext.runTestsExclusively
          && expandFilesets == otherContext.expandFilesets
          && fullyResolveFilesetSymlinks == otherContext.fullyResolveFilesetSymlinks
          && outputGroups.equals(otherContext.outputGroups);
    } else {
      return false;
    }
  }

  @Override
  public int hashCode() {
    return Objects.hash(
        runTestsExclusively, expandFilesets, fullyResolveFilesetSymlinks, outputGroups);
  }
}