Package com.funnelback.plugin.gatherer.mock

Class MockPluginGatherContext

java.lang.Object

com.funnelback.plugin.gatherer.mock.MockPluginGatherContext

All Implemented Interfaces:

PluginConfigurationFileSettingMock, com.funnelback.plugin.gatherer.PluginGatherContext, com.funnelback.plugin.PluginBaseConfigContext, com.funnelback.plugin.PluginBaseConfigFileContext, com.funnelback.plugin.PluginBaseContext

public class MockPluginGatherContext
extends Object
implements com.funnelback.plugin.gatherer.PluginGatherContext, PluginConfigurationFileSettingMock

A Mock PluginGatherContext that may be used when testing the PluginGatherer. Example:

 MockPluginGatherContext pluginGatherContext = new MockPluginGatherContext();
 // Set collection config setting 'foo=bar'.
 pluginGatherContext.setConfigSetting("foo", "bar");
 
 MockPluginStore pluginStore = new MockPluginStore();
 
 PluginGatherer underTest = new MyPluginGatherer();
 
 underTest.gather(pluginGatherContext, pluginStore);
 

Field Summary

Fields

Modifier and Type	Field	Description
private String	collectionName
private String	configSetting
private MapBackedConfig	mapBackedConfig
private MapBackedPluginConfigurationFiles	mapBackedPluginConfigurationFiles
private File	searchHome

Constructor Summary

Constructors

Constructor	Description
MockPluginGatherContext()

Method Summary

Modifier and Type	Method	Description
String	getCollectionName()
Set<String>	getConfigKeys()
Map<String,List<String>>	getConfigKeysMatchingPattern(String pattern)
Set<String>	getConfigKeysWithPrefix(String prefix)
String	getConfigSetting()
String	getConfigSetting(String key)
File	getSearchHome()
Optional<String>	pluginConfigurationFile(String filename)
Optional<byte[]>	pluginConfigurationFileAsBytes(String filename)
void	setCollectionName(String collectionName)
void	setConfigSetting(String configSetting)
void	setConfigSetting(String key, String value)
void	setPlugingConfigurationFileContent(String filename, String content)	Sets the content of a plugin configuration file on the mock.
void	setPlugingConfigurationFileContentAsBytes(String filename, byte[] content)	Sets the content of a plugin configuration file on the mock.
void	setSearchHome(File searchHome)

Methods inherited from class java.lang.Object

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

Field Detail

searchHome

private File searchHome

collectionName

private String collectionName

configSetting

private String configSetting

mapBackedConfig

private final MapBackedConfig mapBackedConfig

mapBackedPluginConfigurationFiles

private final MapBackedPluginConfigurationFiles mapBackedPluginConfigurationFiles

Constructor Detail

MockPluginGatherContext

public MockPluginGatherContext()

Method Detail

getSearchHome

public File getSearchHome()

Specified by:

getSearchHome in interface com.funnelback.plugin.PluginBaseContext

setSearchHome

public void setSearchHome(File searchHome)

getCollectionName

public String getCollectionName()

Specified by:

getCollectionName in interface com.funnelback.plugin.PluginBaseContext

setCollectionName

public void setCollectionName(String collectionName)

getConfigSetting

public String getConfigSetting()

setConfigSetting

public void setConfigSetting(String configSetting)

setConfigSetting

public void setConfigSetting(String key,
                             String value)

Specified by:

setConfigSetting in interface com.funnelback.plugin.gatherer.PluginGatherContext

getConfigSetting

public String getConfigSetting(String key)

Specified by:

getConfigSetting in interface com.funnelback.plugin.PluginBaseConfigContext

getConfigKeys

public Set<String> getConfigKeys()

getConfigKeysWithPrefix

public Set<String> getConfigKeysWithPrefix(String prefix)

Specified by:

getConfigKeysWithPrefix in interface com.funnelback.plugin.PluginBaseConfigContext

getConfigKeysMatchingPattern

public Map<String,List<String>> getConfigKeysMatchingPattern(String pattern)

Specified by:

getConfigKeysMatchingPattern in interface com.funnelback.plugin.PluginBaseConfigContext

setPlugingConfigurationFileContent

public void setPlugingConfigurationFileContent(String filename,
                                               String content)

Description copied from interface: PluginConfigurationFileSettingMock

Sets the content of a plugin configuration file on the mock.

Specified by:

setPlugingConfigurationFileContent in interface PluginConfigurationFileSettingMock

Parameters:

filename - the name of the plugins configuration file e.g. maps.cfg

setPlugingConfigurationFileContentAsBytes

public void setPlugingConfigurationFileContentAsBytes(String filename,
                                                      byte[] content)

Description copied from interface: PluginConfigurationFileSettingMock

Sets the content of a plugin configuration file on the mock.

Specified by:

setPlugingConfigurationFileContentAsBytes in interface PluginConfigurationFileSettingMock

Parameters:

filename - the name of the plugins configuration file e.g. maps.cfg

pluginConfigurationFileAsBytes

public Optional<byte[]> pluginConfigurationFileAsBytes(String filename)

Specified by:

pluginConfigurationFileAsBytes in interface com.funnelback.plugin.PluginBaseConfigFileContext

pluginConfigurationFile

public Optional<String> pluginConfigurationFile(String filename)

Specified by:

pluginConfigurationFile in interface com.funnelback.plugin.PluginBaseConfigFileContext