View Javadoc

1   /*
2    * Copyright 2015 Data Archiving and Networked Services (an institute of
3    * Koninklijke Nederlandse Akademie van Wetenschappen), King's College London,
4    * Georg-August-Universitaet Goettingen Stiftung Oeffentlichen Rechts
5    *
6    * Licensed under the EUPL, Version 1.1 or – as soon they will be approved by
7    * the European Commission - subsequent versions of the EUPL (the "Licence");
8    * You may not use this work except in compliance with the Licence.
9    * You may obtain a copy of the Licence at:
10   *
11   * https://joinup.ec.europa.eu/software/page/eupl
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the Licence is distributed on an "AS IS" basis,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the Licence for the specific language governing
17   * permissions and limitations under the Licence.
18   */
19  
20  package eu.ehri.project.utils.fixtures;
21  
22  import java.io.InputStream;
23  
24  /**
25   * Interface for classes which handle fixture loading.
26   */
27  public interface FixtureLoader {
28  
29      /**
30       * Toggle whether or not initialization occurs before
31       * loading (default: true)
32       */
33      FixtureLoader setInitializing(boolean toggle);
34  
35      /**
36       * Load the default fixtures.
37       */
38      void loadTestData();
39  
40      /**
41       * Load a given InputStream as test data. The stream
42       * will be closed automatically.
43       * @param inputStream An imput stream of fixture data
44       */
45      void loadTestData(InputStream inputStream);
46  
47      /**
48       * Load a given file as test data.
49       *
50       * @param resourceNameOrPath A resource name or file path
51       *                           containing fixture data.
52       */
53      void loadTestData(String resourceNameOrPath);
54  }