org.tinymediamanager.scraper.config

Class MediaProviderConfig

java.lang.Object

org.tinymediamanager.scraper.config.MediaProviderConfig

public class MediaProviderConfig
extends Object

This class is used to provide a configuration interface for scrapers

Author:

Myron Boyle

Constructor Summary

Constructors

Constructor and Description
MediaProviderConfig(MediaProviderInfo mpi)

Method Summary

Modifier and Type	Method and Description
void	addBoolean(String key, boolean defaultValue)
void	addSelect(String key, String[] possibleValues, String defaultValue)
void	addSelectIndex(String key, String[] possibleValues, String defaultValue)
void	addText(String key, String defaultValue)
void	addText(String key, String defaultValue, boolean encrypt)
Map<String,String>	getConfigKeyValuePairs() convenient method, to return a key=value map of all config entries
MediaProviderConfigObject	getConfigObject(String key) returns a config object (or an empty one if not found)
Map<String,MediaProviderConfigObject>	getConfigObjects()
String	getValue(String key) gets the config value as string (or the default) You might want to parse it to boolean if it is true|false You might get a number if it was setup to return the index might return an empty string!
Boolean	getValueAsBool(String key) If you know that this key is a boolean, use that :) will return NULL if it cannot be parsed as boolean
Integer	getValueIndex(String key) gets the config value as index works only on select boxes might return NULL if not found/parseable
boolean	hasConfig() indicate whether a config is available or not
void	load() loads config from settings file Should be called right after defining the configuration objects!
void	loadFromDir(String folder) Deprecated.
void	save()
void	saveToDir(String folder) Deprecated.
void	setValue(String key, boolean value)
void	setValue(String key, String value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaProviderConfig

public MediaProviderConfig(MediaProviderInfo mpi)

Method Detail

load

public void load()

loads config from settings file
Should be called right after defining the configuration objects!

loadFromDir

@Deprecated
public void loadFromDir(String folder)

Deprecated.

convenient method for unit testing - should not be used otherwise

save

public void save()

saveToDir

@Deprecated
public void saveToDir(String folder)

Deprecated.

convenient method for unit testing - should not be used otherwise

hasConfig

public boolean hasConfig()

indicate whether a config is available or not

Returns:

true/false

getConfigObjects

public Map<String,MediaProviderConfigObject> getConfigObjects()

getConfigKeyValuePairs

public Map<String,String> getConfigKeyValuePairs()

convenient method, to return a key=value map of all config entries

Returns:

getConfigObject

public MediaProviderConfigObject getConfigObject(String key)

returns a config object (or an empty one if not found)

Parameters:

key -

Returns:

getValue

public String getValue(String key)

gets the config value as string (or the default)
You might want to parse it to boolean if it is true|false
You might get a number if it was setup to return the index
might return an empty string!

Parameters:

key -

Returns:

getValueIndex

public Integer getValueIndex(String key)

gets the config value as index
works only on select boxes
might return NULL if not found/parseable

Parameters:

key -

Returns:

getValueAsBool

public Boolean getValueAsBool(String key)

If you know that this key is a boolean, use that :)
will return NULL if it cannot be parsed as boolean

Parameters:

key -

Returns:

true|false or NULL

setValue

public void setValue(String key,
                     String value)

setValue

public void setValue(String key,
                     boolean value)

addBoolean

public void addBoolean(String key,
                       boolean defaultValue)

addText

public void addText(String key,
                    String defaultValue)

addText

public void addText(String key,
                    String defaultValue,
                    boolean encrypt)

addSelect

public void addSelect(String key,
                      String[] possibleValues,
                      String defaultValue)

addSelectIndex

public void addSelectIndex(String key,
                           String[] possibleValues,
                           String defaultValue)

toString

public String toString()

Overrides:

toString in class Object