src/main/java/com/google/devtools/build/lib/platform/SystemCPUSpeedEvent.java

// Copyright 2022 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.platform;

import static com.google.common.base.Preconditions.checkArgument;

import com.google.devtools.build.lib.events.ExtendedEventHandler;

/**
 * This event is fired from {@link
 * com.google.devtools.build.lib.platform.SystemCPUSpeedModule#cpuSpeedCallback} to indicate that a
 * cpu speed event has occurred.
 */
public class SystemCPUSpeedEvent implements ExtendedEventHandler.Postable {
  private final int speed;

  /**
   * SystemCPUSpeedEvent Constructor.
   *
   * @param speed The actual speed (1-100).
   */
  public SystemCPUSpeedEvent(int speed) {
    checkArgument(speed > 0 && speed <= 100);
    this.speed = speed;
  }

  public int speed() {
    return speed;
  }

  public String logString() {
    return String.format("SystemCPUSpeedEvent: %d", speed);
  }
}