original

[gb-231r1-is01/GB_2.3_IS01.git] / tools / tradefederation / src / com / android / tradefed / config / IConfiguration.java

diff --git a/tools/tradefederation/src/com/android/tradefed/config/IConfiguration.java b/tools/tradefederation/src/com/android/tradefed/config/IConfiguration.java
new file mode 100644 (file)
index 0000000..8f034b0
--- /dev/null
+++ b/tools/tradefederation/src/com/android/tradefed/config/IConfiguration.java
@@ -0,0 +1,141 @@
+/*
+ * Copyright (C) 2010 The Android Open Source Project
+ *
+ * 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.android.tradefed.config;
+
+import com.android.tradefed.device.IDeviceRecovery;
+import com.android.tradefed.log.ILeveledLogOutput;
+import com.android.tradefed.result.ITestInvocationListener;
+import com.android.tradefed.targetsetup.IBuildProvider;
+import com.android.tradefed.targetsetup.ITargetPreparer;
+
+import java.util.Collection;
+import java.util.List;
+
+import junit.framework.Test;
+
+/**
+ * Configuration information for a TradeFederation invocation.
+ *
+ * Each TradeFederation invocation has a single {@link IConfiguration}. An {@link IConfiguration}
+ * stores all the delegate objects that should be used during the invocation, and their associated
+ * {@link Option}'s
+ */
+public interface IConfiguration {
+
+    /**
+     * Gets the {@link IBuildProvider} from the configuration.
+     *
+     * @return the {@link IBuildProvider} provided in the configuration
+     * @throws ConfigurationException if config object could not be fully loaded, or was not the
+     * correct type
+     */
+    public IBuildProvider getBuildProvider() throws ConfigurationException;
+
+    /**
+     * Gets the {@link ITargetPreparer}s from the configuration.
+     *
+     * @return the {@link ITargetPreparer}s provided in order in the configuration
+     * @throws ConfigurationException if config object could not be fully loaded, or was not the
+     * correct type
+     */
+    public List<ITargetPreparer> getTargetPreparers() throws ConfigurationException;
+
+    /**
+     * Gets the {@link Test}s to run from the configuration.
+     *
+     * @return the {@link Test}s provided in the configuration
+     * @throws ConfigurationException if config objects could not be fully loaded, or was not the
+     * correct type
+     */
+    public List<Test> getTests()  throws ConfigurationException;
+
+    /**
+     * Gets the {@link ITestInvocationListener}s to use from the configuration.
+     *
+     * @return the {@link ITestInvocationListener}s provided in the configuration.
+     * @throws ConfigurationException if config objects could not be fully loaded, or was not the
+     * correct type
+     */
+    public List<ITestInvocationListener> getTestInvocationListeners() throws ConfigurationException;
+
+    /**
+     * Gets the {@link IDeviceRecovery} to use from the configuration.
+     *
+     * @return the {@link IDeviceRecovery} provided in the configuration.
+     * @throws ConfigurationException if config object could not be fully loaded, or was not the
+     * correct type
+     */
+    public IDeviceRecovery getDeviceRecovery() throws ConfigurationException;
+
+    /**
+     * Gets the {@link ILeveledLogOutput} to use from the configuration.
+     *
+     * @return the {@link ILeveledLogOutput} provided in the configuration.
+     * @throws ConfigurationException if config object could not be fully loaded, or was not the
+     * correct type
+     */
+    public ILeveledLogOutput getLogOutput() throws ConfigurationException;
+
+    /**
+     * Generic interface to get the configuration object with the given name.
+     *
+     * @param name the unique name of the configuration object
+     * @param expectedType the expected object type
+     *
+     * @return the configuration object, with all its {@link Option} fields set
+     *
+     * @throws ConfigurationException if config object could not be fully loaded, or was not the
+     * correct type
+     */
+    public Object getConfigurationObject(String name, Class<?> expectedType)
+            throws ConfigurationException;
+
+    /**
+     * Similar to {@link #getConfigurationObject(String, Class)}, but for configuration
+     * object types that support multiple objects.
+     *
+     * @param name the unique name of the configuration object
+     * @param expectedType the expected object type
+     *
+     * @return the list of configuration objects, with all its {@link Option} fields set
+     *
+     * @throws ConfigurationException if any of the config object could not be fully loaded, or
+     * were not the correct type
+     */
+    public List<?> getConfigurationObjectList(String name, Class<?> expectedType)
+            throws ConfigurationException;
+
+    /**
+     * Inject a option value into the set of configuration objects.
+     * <p/>
+     * Useful to provide values for options that are generated dynamically.
+     *
+     * @param optionName the option name
+     * @param optionValue the option value
+     * @throws ConfigurationException if failed to set the option's value
+     */
+    public void injectOptionValue(String optionName, String optionValue)
+            throws ConfigurationException;
+
+    /**
+     * Gets a copy of the list of all configuration objects.
+     *
+     * @return a {@link Collection} of all configuration objects
+     * @throws {@link ConfigurationException} if the config objects could not be fully loaded
+     */
+    public Collection<Object> getAllConfigurationObjects() throws ConfigurationException;
+}