Package dev.galasa.artifact

Interface IBundleResources

public interface IBundleResources

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RESOURCES_DIRECTORY

Method Summary

Modifier and Type	Method	Description
Map<String,InputStream>	retrieveDirectoryContents(String directory)	For a directory, retrieve a map of file paths within it, and InputStreams for those files.
InputStream	retrieveFile(String path)	Retrieve a single file as an InputStream
String	retrieveFileAsString(String path)	Retrieve the contents of a file as a String
InputStream	retrieveJar(String symbolicName, String version, String directory)	Retrieve a jar file as an input stream
Map<String,InputStream>	retrieveSkeletonDirectoryContents(String directory, Map<String,Object> parameters, int skeletonType)	For a directory, retrieve a map of file paths within it, and InputStreams for those files, if the file is a skeleton then any required substitutions will be performed before the stream is returned.
InputStream	retrieveSkeletonFile(String path, Map<String,Object> parameters)	Retrieve a single file as an InputStream If the file is a skeleton then any required substitutions will be performed before the stream is returned.
InputStream	retrieveSkeletonFile(String path, Map<String,Object> parameters, int skeletonType)	Retrieve a single file as an InputStream, if the file is a skeleton then any required substitutions will be performed before the stream is returned.
String	retrieveSkeletonFileAsString(String path, Map<String,Object> parameters)	Retrieve a single file as a String If the file is a skeleton then any required substitutions will be performed before the string is returned.
List<String>	streamAsList(InputStream file)	Convert an input stream into a list of strings
String	streamAsString(InputStream file)	Convert an input stream into a string
InputStream	zipDirectoryContents(String resourcesDirectory, Map<String,Object> parameters, String encoding, boolean gzip)

Field Details

RESOURCES_DIRECTORY

static final String RESOURCES_DIRECTORY

See Also:

• Constant Field Values

Method Details

retrieveFile

InputStream retrieveFile(String path)
                  throws TestBundleResourceException

Retrieve a single file as an InputStream

Parameters:

path -

Returns:

Throws:

TestBundleResourceException

retrieveFileAsString

String retrieveFileAsString(String path)
                     throws TestBundleResourceException,
IOException

Retrieve the contents of a file as a String

Parameters:

path - The path to the file to which will be read

Returns:

The contents of the file

Throws:

TestBundleResourceException

IOException

retrieveSkeletonFile

InputStream retrieveSkeletonFile(String path,
 Map<String,Object> parameters,
 int skeletonType)
                          throws TestBundleResourceException

Retrieve a single file as an InputStream, if the file is a skeleton then any required substitutions will be performed before the stream is returned.

Parameters:

path -

parameters -

skeletonType -

Returns:

Throws:

TestBundleResourceException

retrieveSkeletonFile

InputStream retrieveSkeletonFile(String path,
 Map<String,Object> parameters)
                          throws TestBundleResourceException

Retrieve a single file as an InputStream If the file is a skeleton then any required substitutions will be performed before the stream is returned. Uses the default ISkeletonProcessor

Parameters:

path - The path to the file

parameters -

Returns:

A stream so the caller can read the contents of the file

Throws:

TestBundleResourceException

retrieveSkeletonFileAsString

String retrieveSkeletonFileAsString(String path,
 Map<String,Object> parameters)
                             throws TestBundleResourceException,
IOException

Retrieve a single file as a String If the file is a skeleton then any required substitutions will be performed before the string is returned. Uses the default ISkeletonProcessor

Parameters:

path - The path to the file to be read

parameters -

Returns:

The contents of the file

Throws:

TestBundleResourceException

IOException

retrieveDirectoryContents

Map<String,InputStream> retrieveDirectoryContents(String directory)
                                           throws TestBundleResourceException

For a directory, retrieve a map of file paths within it, and InputStreams for those files.

Parameters:

directory -

Returns:

Throws:

TestBundleResourceException

retrieveSkeletonDirectoryContents

Map<String,InputStream> retrieveSkeletonDirectoryContents(String directory,
 Map<String,Object> parameters,
 int skeletonType)
                                                   throws TestBundleResourceException

For a directory, retrieve a map of file paths within it, and InputStreams for those files, if the file is a skeleton then any required substitutions will be performed before the stream is returned.

Parameters:

directory -

Returns:

Throws:

TestBundleResourceException

retrieveJar

InputStream retrieveJar(String symbolicName,
 String version,
 String directory)
                 throws TestBundleResourceException

Retrieve a jar file as an input stream

Parameters:

symbolicName -

version -

directory -

Returns:

Throws:

TestBundleResourceException

streamAsList

List<String> streamAsList(InputStream file)
                   throws IOException

Convert an input stream into a list of strings

Parameters:

file -

Returns:

Throws:

IOException

streamAsString

String streamAsString(InputStream file)
               throws IOException

Convert an input stream into a string

Parameters:

file -

Returns:

Throws:

IOException

zipDirectoryContents

InputStream zipDirectoryContents(String resourcesDirectory,
 Map<String,Object> parameters,
 String encoding,
 boolean gzip)
                          throws TestBundleResourceException

Throws:

TestBundleResourceException