aboutsummaryrefslogtreecommitdiffstats
path: root/src/testcases/org/apache/poi/ss/ITestDataProvider.java
blob: e10bfcf7c0666c629caf04110250b19dd945491d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/* ====================================================================
   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.poi.ss;

import org.apache.poi.ss.usermodel.Workbook;

/**
 * Encapsulates a provider of test data for common HSSF / XSSF tests.
 */
public interface ITestDataProvider {
    /**
     * Override to provide HSSF / XSSF specific way for re-serialising a workbook
     *
     * @param wb the workbook to re-serialize
     * @return the re-serialized workbook
     */
    Workbook writeOutAndReadBack(Workbook wb);

    /**
     * Override to provide way of loading HSSF / XSSF sample workbooks
     *
     * @param sampleFileName the file name to load
     * @return an instance of Workbook loaded from the supplied file name
     */
    Workbook openSampleWorkbook(String sampleFileName);

    /**
     * Override to provide way of creating HSSF / XSSF workbooks
     * @return an instance of Workbook
     */
    Workbook createWorkbook();

    /**
     * Opens a sample file from the standard HSSF test data directory
     *
     * @return an open <tt>InputStream</tt> for the specified sample file
     */
    byte[] getTestDataFileContent(String fileName);

    SpreadsheetVersion getSpreadsheetVersion();
}