src/com/facebook/buck/rules/BuildEvent.java

/*
 * Copyright 2013-present Facebook, Inc.
 *
 * 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.facebook.buck.rules;

import com.facebook.buck.event.AbstractBuckEvent;
import com.facebook.buck.event.BuckEvent;
import com.facebook.buck.model.BuildTarget;
import com.google.common.base.Joiner;
import com.google.common.base.Objects;
import com.google.common.collect.ImmutableSet;

/**
 * Base class for events about building.
 */
@SuppressWarnings("PMD.OverrideBothEqualsAndHashcode")
public abstract class BuildEvent extends AbstractBuckEvent {
  private final ImmutableSet<BuildTarget> buildTargets;

  /**
   * @param buildTargets The list of {@link BuildTarget}s being built.
   */
  protected BuildEvent(ImmutableSet<BuildTarget> buildTargets) {
    this.buildTargets = ImmutableSet.copyOf(buildTargets);
  }

  public ImmutableSet<BuildTarget> getBuildTargets() {
    return buildTargets;
  }

  public static Started started(ImmutableSet<BuildTarget> buildTargets) {
    return new Started(buildTargets);
  }

  public static Finished finished(ImmutableSet<BuildTarget> buildTargets, int exitCode) {
    return new Finished(buildTargets, exitCode);
  }

  public static RuleCountCalculated ruleCountCalculated(
      ImmutableSet<BuildTarget> buildTargets,
      int ruleCount) {
    return new RuleCountCalculated(buildTargets, ruleCount);
  }

  @Override
  protected String getValueString() {
    return Joiner.on(", ").join(buildTargets);
  }

  @Override
  public boolean isRelatedTo(BuckEvent event) {
    if (!(event instanceof BuildEvent)) {
      return false;
    }

    BuildEvent that = (BuildEvent) event;

    return Objects.equal(getClass(), event.getClass()) &&
        Objects.equal(getBuildTargets(), that.getBuildTargets());
  }

  @Override
  public int hashCode() {
    return buildTargets.hashCode();
  }

  public static class Started extends BuildEvent {
    protected Started(ImmutableSet<BuildTarget> buildTargets) {
      super(buildTargets);
    }

    @Override
    public String getEventName() {
      return "BuildStarted";
    }
  }

  public static class Finished extends BuildEvent {
    private final int exitCode;

    protected Finished(ImmutableSet<BuildTarget> buildRules, int exitCode) {
      super(buildRules);
      this.exitCode = exitCode;
    }

    public int getExitCode() {
      return exitCode;
    }

    @Override
    public String getEventName() {
      return "BuildFinished";
    }

    @Override
    public boolean equals(Object o) {
      if (!super.equals(o)) {
        return false;
      }

      Finished that = (Finished) o;
      return that.exitCode == getExitCode();
    }

    @Override
    public int hashCode() {
      return Objects.hashCode(getBuildTargets(), getExitCode());
    }
  }

  public static class RuleCountCalculated extends BuildEvent {
    private final int numRules;

    protected RuleCountCalculated(ImmutableSet<BuildTarget> buildRules, int numRulesToBuild) {
      super(buildRules);
      this.numRules = numRulesToBuild;
    }

    public int getNumRules() {
      return numRules;
    }

    @Override
    public String getEventName() {
      return "RuleCountCalculated";
    }

    @Override
    public boolean equals(Object o) {
      if (!super.equals(o)) {
        return false;
      }

      RuleCountCalculated that = (RuleCountCalculated) o;
      return that.getNumRules() == getNumRules();
    }

    @Override
    public int hashCode() {
      return Objects.hashCode(getBuildTargets(), getNumRules());
    }
  }
}