com.paypal.selion.platform.dataprovider.impl

Class FileSystemResource

java.lang.Object

com.paypal.selion.platform.dataprovider.impl.FileSystemResource

All Implemented Interfaces:

DataResource

Direct Known Subclasses:

XmlFileSystemResource

public class FileSystemResource
extends Object
implements DataResource

FileSystemResource defines the file name of the data source to be used for data provider consumption. Loading a file (Yaml for e.g.,) containing user-defined (complex) objects also requires passing in the object class. Passing in a complex object with nested complex objects does not require any additional parameters.

Sample usage:

 public static Object[][] dataProviderGetAllDocuments() throws IOException {
     FileSystemResource resource = new FileSystemResource(fileName, USER.class);
     Object[][] data = YamlDataProvider.getAllData(resource);
     return data;
 }
 

If test requires passing multiple arguments, multiple YamlResources can be defined to create such a data provider.

Sample usage:

 public static Object[][] dataProviderGetMultipleArguments() throws IOException {
     List<FileSystemResource> yamlResources = new ArrayList<FileSystemResource>();
     yamlResources.add(new FileSystemResource(fileName1, USER.class));
     yamlResources.add(new FileSystemResource(fileName2, USER.class));
 
     Object[][] data = YamlDataProvider.getAllDataMultipleArgs(yamlResources);
 
     return data;
 }
 

Test method signature example:

   public void testExample(USER user1, USER user2)
 

Constructor Summary

Constructors

Constructor and Description
FileSystemResource(String fileName) Use this constructor when a data source file can be found as a resource and does NOT contain a user-defined object.
FileSystemResource(String fileName, Class<?> cls) Use this constructor when a data source file can be found as a resource and contains a user-defined object.

Method Summary

Modifier and Type	Method and Description
Class<?>	getCls() Fetch the user defined POJO class
InputStream	getInputStream() Load the input stream of the data file
String	getType() Fetch the data file extension
void	setCls(Class<?> cls) Set the user defined POJO class to map data
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FileSystemResource

public FileSystemResource(String fileName,
                          Class<?> cls)

Use this constructor when a data source file can be found as a resource and contains a user-defined object.

Parameters:

fileName -

cls -

FileSystemResource

public FileSystemResource(String fileName)

Use this constructor when a data source file can be found as a resource and does NOT contain a user-defined object.

Parameters:

fileName -

Method Detail

getCls

public Class<?> getCls()

Description copied from interface: DataResource

Fetch the user defined POJO class

Specified by:

getCls in interface DataResource

Returns:

The class

setCls

public final void setCls(Class<?> cls)

Description copied from interface: DataResource

Set the user defined POJO class to map data

Specified by:

setCls in interface DataResource

getInputStream

public InputStream getInputStream()

Description copied from interface: DataResource

Load the input stream of the data file

Specified by:

getInputStream in interface DataResource

Returns:

The inputStream

getType

public String getType()

Description copied from interface: DataResource

Fetch the data file extension

Specified by:

getType in interface DataResource

Returns:

The type

toString

public String toString()

Overrides:

toString in class Object