src/main/java/com/google/devtools/build/lib/skyframe/ConfiguredTargetProgressReceiver.java

// Copyright 2018 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.skyframe;

import java.util.concurrent.atomic.AtomicInteger;

/**
 * A class that, when being told the end of a target being configured, keeps track of the
 * configuration progress and provides it as a human-readable string intended for the progress bar.
 */
public class ConfiguredTargetProgressReceiver {

  private AtomicInteger configuredTargetsCompleted = new AtomicInteger();

  /** Register that a target has been configured. */
  void doneConfigureTarget() {
    configuredTargetsCompleted.incrementAndGet();
  }

  /**
   * Reset all instance variables of this object to a state equal to that of a newly
   * constructed object.
   */
  public void reset() {
    configuredTargetsCompleted.set(0);
  }

  /**
   * Return a snapshot of the configuration progress as human-readable description of the number of
   * targets configured so far.
   */
  public String getProgressString() {
    String progress = "" + configuredTargetsCompleted + " ";
    progress += (configuredTargetsCompleted.get() != 1) ? "targets" : "target";
    progress += " configured";
    return progress;
  }
}