View Javadoc
1   /*
2    * Copyright 2002-2016 the original author or authors
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  
17  package com.github.springtestdbunit.dataset;
18  
19  import org.dbunit.dataset.IDataSet;
20  
21  /**
22   * Strategy interface for {@link #loadDataSet loading} a {@link IDataSet dataset}.
23   * <p>
24   * Concrete implementations must provide a <code>public</code> no-args constructor.
25   *
26   * @author Phillip Webb
27   *
28   * @see FlatXmlDataSetLoader
29   */
30  public interface DataSetLoader {
31  
32  	/**
33  	 * Load and return {@link IDataSet dataset} from the specified. If the dataset cannot be found <tt>null</tt> may be
34  	 * returned.
35  	 * @param testClass The class under test
36  	 * @param location The location to load
37  	 * @return a {@link IDataSet dataset} or <tt>null</tt>
38  	 * @throws Exception If the {@link IDataSet dataset} cannot be loaded
39  	 */
40  	public IDataSet loadDataSet(Class<?> testClass, String location) throws Exception;
41  
42  }