src/main/java/com/google/devtools/build/lib/concurrent/ComparableRunnable.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.concurrent;

/**
 * {@link Runnable} that is also {@link Comparable} for prioritization.
 *
 * <p>Requires {@link Comparable#compareTo} implementations to be <i>consistent with equals</i>.
 */
public interface ComparableRunnable extends Runnable, Comparable<ComparableRunnable> {
  /**
   * Hint that a task may require significant CPU.
   *
   * <p>Schedulers take extra care to not oversubscribe such tasks.
   */
  default boolean isCpuHeavy() {
    return false;
  }
}