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.result.suite;
17 
18 import java.io.File;
19 import java.io.IOException;
20 
21 /** Interface describing a formatter for {@link SuiteResultHolder}. */
22 public interface IFormatterGenerator {
23 
24     /**
25      * Write the results into a particular format.
26      *
27      * @param holder The results held in {@link SuiteResultHolder}.
28      * @param resultDir The directory where results should be stored.
29      * @return a {@link File} containing the results in a formatted manner.
30      */
writeResults(SuiteResultHolder holder, File resultDir)31     public File writeResults(SuiteResultHolder holder, File resultDir) throws IOException;
32 
33     /**
34      * Reverse operation of {@link #writeResults(SuiteResultHolder, File)} which takes a result
35      * directory and create the {@link SuiteResultHolder} out of it.
36      *
37      * @param resultDir The directory where to find the results.
38      * @param shallow only load the top level information of {@link SuiteResultHolder}.
39      * @return A {@link SuiteResultHolder} containing the results representation. Or null if
40      *     anything goes wrong.
41      */
parseResults(File resultDir, boolean shallow)42     public SuiteResultHolder parseResults(File resultDir, boolean shallow) throws IOException;
43 }
44