Home | History | Annotate | Download | only in shard
      1 /*
      2  * Copyright (C) 2017 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 package com.android.tradefed.invoker.shard;
     17 
     18 import com.android.tradefed.config.IConfiguration;
     19 import com.android.tradefed.invoker.IInvocationContext;
     20 import com.android.tradefed.invoker.IRescheduler;
     21 
     22 /** Interface of an object that describes the sharding strategy to adopt for a configuration. */
     23 public interface IShardHelper {
     24 
     25     /**
     26      * Shard and reschedule the shard if possible.
     27      *
     28      * @param config a {@link IConfiguration} to be run.
     29      * @param context the {@link IInvocationContext} of the current invocation.
     30      * @param rescheduler the {@link IRescheduler} where to reschedule the shards.
     31      * @return True if the configuration was sharded. false otherwise.
     32      */
     33     public boolean shardConfig(
     34             IConfiguration config, IInvocationContext context, IRescheduler rescheduler);
     35 }
     36