storm-server/src/main/java/org/apache/storm/scheduler/resource/strategies/scheduling/sorter/IExecSorter.java

/*
 * 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.
 */

package org.apache.storm.scheduler.resource.strategies.scheduling.sorter;

import java.util.List;
import java.util.Set;

import org.apache.storm.scheduler.ExecutorDetails;


public interface IExecSorter {
    /**
     * Sort the supplied unique collection of ExecutorDetails in the order
     * in which they should be scheduled. Both the input and output collections
     * contain the same number of unique ExecutorDetails.
     *
     * @param execs an unmodifiable set of executors that need to be scheduled.
     * @return a list of executors in sorted order for scheduling.
     */
    List<ExecutorDetails> sortExecutors(Set<ExecutorDetails> execs);
}