package org.apache.helix.controller.rebalancer.condition;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

import org.apache.helix.controller.dataproviders.ResourceControllerDataProvider;

/**
 * The {@code RebalanceCondition} interface defines a condition under which a rebalance operation
 * should be performed. Implementations of this interface provide specific criteria to determine
 * whether a rebalance is necessary based on the current state of the system.
 */
public interface RebalanceCondition {
  /**
   * Determines whether a rebalance should be performed based on the provided
   * {@link ResourceControllerDataProvider} cache data.
   *
   * @param cache the {@code ResourceControllerDataProvider} cached data of the resources being managed.
   * @return {@code true} if the rebalance should be performed, {@code false} otherwise.
   */
  boolean shouldPerformRebalance(ResourceControllerDataProvider cache);
}
