1 /*
2  * Copyright (C) 2018 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.testtype.suite.params;
17 
18 import com.android.tradefed.config.IConfiguration;
19 
20 /** The interface for parameters of suites modules. */
21 public interface IModuleParameter {
22 
23     /** Returns the name the parameterized module will be identified as. */
getParameterIdentifier()24     public String getParameterIdentifier();
25 
26     /**
27      * Adds to {@link IConfiguration} with the parameter specific needs. For example, insert or
28      * remove target preparers from configuration.
29      */
addParameterSpecificConfig(IConfiguration moduleConfiguration)30     default void addParameterSpecificConfig(IConfiguration moduleConfiguration) {}
31 
32     /**
33      * Apply to the module {@link IConfiguration} the parameter specific module setup. For example,
34      * this could be extra options for the preparers or the tests.
35      */
applySetup(IConfiguration moduleConfiguration)36     public void applySetup(IConfiguration moduleConfiguration);
37 }
38