com.workfusion.rpa.helpers

Class Resource

java.lang.Object

com.workfusion.rpa.helpers.Resource

public class Resource
extends java.lang.Object

This class adds static methods for work this file system.

Driver Type: Desktop

Method Summary

Modifier and Type	Method and Description
static void	append(java.lang.String path, java.lang.String value, java.lang.String encoding) Appends content to file
static void	copyFail(java.lang.String resourceFrom, java.lang.String pathTo) Copies file or directory.
static void	copyOverwrite(java.lang.String resourceFrom, java.lang.String pathTo) Copies file or directory.
static void	copySkip(java.lang.String resourceFrom, java.lang.String pathTo) Copies file or directory.
static boolean	createDirectoryFail(java.lang.String path) Creates new directory.
static boolean	createDirectoryOverwrite(java.lang.String path) Creates new directory.
static boolean	createDirectorySkip(java.lang.String path) Creates new directory.
static boolean	createFileFail(java.lang.String path) Create new file.
static boolean	createFileOverwrite(java.lang.String path) Create new file.
static boolean	createFileSkip(java.lang.String path) Create new file.
static boolean	delete(java.lang.String path) Delete file or directory
static boolean	exist(java.lang.String path) Check if file or directory exists
static java.util.List<java.lang.String>	listFolder(java.lang.String path) Lists directory contents of files
static java.util.List<java.lang.String>	listFolder(java.lang.String path, Filter filter) Lists directory contents using spcial filter
static void	moveFail(java.lang.String resourceFrom, java.lang.String pathTo) Moves file or directory.
static void	moveOverwrite(java.lang.String resourceFrom, java.lang.String pathTo) Moves file or directory.
static void	moveSkip(java.lang.String resourceFrom, java.lang.String pathTo) Moves file or directory.
static void	overwrite(java.lang.String path, java.lang.String value, java.lang.String encoding) Overwrites file content
static java.lang.String	read(java.lang.String path, java.lang.String encoding) Reads file content

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

exist

public static boolean exist(java.lang.String path)

Check if file or directory exists

Driver Type: Desktop

Parameters:

path - string representation of path to file or directory.

Returns:

boolean representation of resource existence

Example

def filePath = 'D://temp//whokilledkennedy.docx'

boolean exist = Resource.exist(filePath);

delete

public static boolean delete(java.lang.String path)

Delete file or directory

Driver Type: Desktop

Parameters:

path - string representation of path to file or directory.

Returns:

boolean representation of operation success

Example

def filePath = 'D://temp//whitneses.docx'

boolean deleted = Resource.delete(filePath);

createFileOverwrite

public static boolean createFileOverwrite(java.lang.String path)

Create new file. Overwrite, if file already exists

Driver Type: Desktop

Parameters:

path - string representation of path to file or directory.

Returns:

always returns true

Example

def filePath = 'D://temp//whitneses.txt'

boolean created = Resource.createFileOverwrite(filePath);

createFileSkip

public static boolean createFileSkip(java.lang.String path)

Create new file. Skip, if file already exists

Driver Type: Desktop

Parameters:

path - string representation of path to file or directory.

Returns:

boolean representation of operation success. True - new file was created. False - file already existed

Example

def filePath = 'D://temp//takeovertheworld.pptx'

boolean created = Resource.createFileSkip(filePath);

createFileFail

public static boolean createFileFail(java.lang.String path)

Create new file. Fail with exception, if file already exists

Driver Type: Desktop

Parameters:

path - string representation of path to file or directory.

Returns:

boolean representation of operation success

Throws:

org.openqa.selenium.WebDriverException - if file already exist

Example

def filePath = 'D://temp//takeovertheworld.pptx'

boolean created = Resource.createFileFail(filePath);

listFolder

public static java.util.List<java.lang.String> listFolder(java.lang.String path)

Lists directory contents of files

Driver Type: Desktop

Parameters:

path - string representation of path to file or directory

Returns:

list representation of full path to files in specified directory

Example

def filePath = 'D://temp'

List folderContent = Resource.listFolder(filePath);

listFolder

public static java.util.List<java.lang.String> listFolder(java.lang.String path,
                                                          Filter filter)

Lists directory contents using spcial filter

Driver Type: Desktop

Parameters:

path - string representation of path to file or directory

filter - Filter

Returns:

list of full path to filtered files or/and folders in specified directory(and subdirectories, if specified)

Example

def filePath = 'D://temp'

List folderContent = Resource.listFolder(filePath, Filter.files().pattern('tempFile.*tmp').get());

See Also:

Filter

createDirectoryOverwrite

public static boolean createDirectoryOverwrite(java.lang.String path)

Creates new directory. Overwrite, if directory already exists

Driver Type: Desktop

Parameters:

path - string representation of path to file or directory

Returns:

always returns true

Example

def filePath = 'D://temp//newDirectory'

boolean created = Resource.createDirectoryOverwrite(filePath);

createDirectorySkip

public static boolean createDirectorySkip(java.lang.String path)

Creates new directory. Skip, if directory already exists

Driver Type: Desktop

Parameters:

path - string representation of path to file or directory

Returns:

boolean representation of operation success. True - new directory was created. False - directory already existed

Example

def filePath = 'D://temp//newDirectory'

boolean created = Resource.createDirectorySkip(filePath);

createDirectoryFail

public static boolean createDirectoryFail(java.lang.String path)

Creates new directory. Fails, if directory already exists

Driver Type: Desktop

Parameters:

path - string representation of path to file or directory

Returns:

always returns true

Throws:

org.openqa.selenium.WebDriverException - if directory exist

Example

def filePath = 'D://temp//newDirectory'

boolean created = Resource.createDirectoryFail(filePath);

read

public static java.lang.String read(java.lang.String path,
                                    java.lang.String encoding)

Reads file content

Driver Type: Desktop

Parameters:

path - string representation of path to file or directory

encoding - string representation of file encoding

Returns:

string representation of file content

Example

def filePath = 'D://temp//newDirectory//file.txt'

def content = Resource.read(filePath, 'utf-8');

overwrite

public static void overwrite(java.lang.String path,
                             java.lang.String value,
                             java.lang.String encoding)

Overwrites file content

Driver Type: Desktop

Parameters:

path - string representation of path to file or directory

value - string representation of text to overwrite with

encoding - string representation of file encoding

Example

def filePath = 'D://temp//newDirectory//file.txt'

Resource.overwrite(filePath, 'utf-8');

append

public static void append(java.lang.String path,
                          java.lang.String value,
                          java.lang.String encoding)

Appends content to file

Driver Type: Desktop

Parameters:

path - string representation of path to file or directory

value - string representation of text to append

encoding - string representation of file encoding

Example

def filePath = 'D://temp//newDirectory//file.txt'

Resource.append(filePath, 'added Text', 'utf-8');

copyOverwrite

public static void copyOverwrite(java.lang.String resourceFrom,
                                 java.lang.String pathTo)

Copies file or directory. Overwrites if file/directory already exist

Driver Type: Desktop

Parameters:

resourceFrom - string representation of path to file or directory which should be copied

pathTo - string representation of a copy destination path

Example

def resourceFrom = 'D://temp//file.txt'

def pathTo = 'D://temp//newDirectory//file.txt'

Resource.copyOverwrite(filePath, 'added Text', 'utf-8');

copySkip

public static void copySkip(java.lang.String resourceFrom,
                            java.lang.String pathTo)

Copies file or directory. Skips if file/directory already exist

Driver Type: Desktop

Parameters:

resourceFrom - string representation of path to file or directory which should be copied

pathTo - string representation of a copy destination path

Example

def resourceFrom = 'D://temp//file.txt'

def pathTo = 'D://temp//newDirectory//file.txt'

Resource.copySkip(resourceFrom, pathTo);

copyFail

public static void copyFail(java.lang.String resourceFrom,
                            java.lang.String pathTo)

Copies file or directory. Fails if file/directory already exist

Driver Type: Desktop

Parameters:

resourceFrom - string representation of path to file or directory which should be copied

pathTo - string representation of a copy destination path

Throws:

org.openqa.selenium.WebDriverException -

Example

def resourceFrom = 'D://temp//file.txt'

def pathTo = 'D://temp//newDirectory//file.txt'

Resource.copyFail(resourceFrom, pathTo);

moveOverwrite

public static void moveOverwrite(java.lang.String resourceFrom,
                                 java.lang.String pathTo)

Moves file or directory. Overwrites if file/directory already exist

Driver Type: Desktop

Parameters:

resourceFrom - string representation of path to file or directory which should be copied

pathTo - string representation of a copy destination path

Example

def resourceFrom = 'D://temp//file.txt'

def pathTo = 'D://temp//newDirectory//file.txt'

Resource.moveOverwrite(resourceFrom, pathTo);

moveSkip

public static void moveSkip(java.lang.String resourceFrom,
                            java.lang.String pathTo)

Moves file or directory. Skips if file/directory already exist

Driver Type: Desktop

Parameters:

resourceFrom - string representation of path to file or directory which should be copied

pathTo - string representation of a copy destination path

Example

def resourceFrom = 'D://temp//file.txt'

def pathTo = 'D://temp//newDirectory//file.txt'

Resource.moveSkip(resourceFrom, pathTo);

moveFail

public static void moveFail(java.lang.String resourceFrom,
                            java.lang.String pathTo)

Moves file or directory. Fails if file/directory already exist

Driver Type: Desktop

Parameters:

resourceFrom - string representation of path to file or directory which should be copied

pathTo - string representation of a copy destination path

Throws:

org.openqa.selenium.WebDriverException -

Example

def resourceFrom = 'D://temp//file.txt'

def pathTo = 'D://temp//newDirectory//file.txt'

Resource.moveSkip(resourceFrom, pathTo);