schemacrawler.schemacrawler

Class Config

java.lang.Object

schemacrawler.schemacrawler.Config

All Implemented Interfaces:

Serializable, Map<String,String>, Options

public final class Config
extends Object
implements Options, Map<String,String>

Configuration properties.

Author:

Sualeh Fatehi

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Config() Creates an empty config.
Config(Map<String,String> config) Copies config into a map.
Config(Properties properties) Copies properties into a map.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String,String>>	entrySet()
String	get(Object key)
boolean	getBooleanValue(String propertyName) Gets the value of a property as a boolean.
boolean	getBooleanValue(String propertyName, boolean defaultValue)
double	getDoubleValue(String propertyName, double defaultValue) Gets the value of a property as an double.
<E extends Enum<E>> E	getEnumValue(String propertyName, E defaultValue) Gets the value of a property as an enum.
InclusionRule	getExclusionRule(String optionName)
InclusionRule	getInclusionRule(String optionName)
InclusionRule	getInclusionRule(String includePatternProperty, String excludePatternProperty)
InclusionRule	getInclusionRuleDefaultExclude(String includePatternProperty, String excludePatternProperty)
InclusionRule	getInclusionRuleOrNull(String includePatternProperty, String excludePatternProperty)
int	getIntegerValue(String propertyName, int defaultValue) Gets the value of a property as an integer.
long	getLongValue(String propertyName, long defaultValue) Gets the value of a property as an long.
String	getStringValue(String propertyName, String defaultValue) Gets the value of a property as a string.
boolean	hasValue(String propertyName) Checks if a value is available.
boolean	isEmpty()
Set<String>	keySet()
static Config	loadFile(String configFilename) Loads the SchemaCrawler configuration from properties file.
static Config	loadResource(String resource) Loads the SchemaCrawler configuration, from a properties file stream.
String	put(String key, String value)
void	putAll(Map<? extends String,? extends String> m)
String	remove(Object key)
void	setBooleanValue(String propertyName, boolean value)
<E extends Enum<E>> void	setEnumValue(String propertyName, E value)
void	setStringValue(String propertyName, String value)
int	size()
String	toString()
Collection<String>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Config

public Config()

Creates an empty config.

Config

public Config(Map<String,String> config)

Copies config into a map.

Parameters:

config - Config to copy

Config

public Config(Properties properties)

Copies properties into a map.

Parameters:

properties - Properties to copy

Method Detail

loadFile

public static Config loadFile(String configFilename)

Loads the SchemaCrawler configuration from properties file.

Parameters:

configFilename - Configuration file name.

Returns:

Configuration properties.

Throws:

IOException

loadResource

public static Config loadResource(String resource)

Loads the SchemaCrawler configuration, from a properties file stream.

Parameters:

configStream - Configuration stream.

Returns:

Configuration properties.

clear

public void clear()

Specified by:

clear in interface Map<String,String>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,String>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,String>

entrySet

public Set<Map.Entry<String,String>> entrySet()

Specified by:

entrySet in interface Map<String,String>

get

public String get(Object key)

Specified by:

get in interface Map<String,String>

getBooleanValue

public boolean getBooleanValue(String propertyName)

Gets the value of a property as a boolean.

Parameters:

propertyName - Property name

Returns:

Boolean value

getBooleanValue

public boolean getBooleanValue(String propertyName,
                               boolean defaultValue)

getDoubleValue

public double getDoubleValue(String propertyName,
                             double defaultValue)

Gets the value of a property as an double.

Parameters:

propertyName - Property name

Returns:

Double value

getEnumValue

public <E extends Enum<E>> E getEnumValue(String propertyName,
                                          E defaultValue)

Gets the value of a property as an enum.

Parameters:

propertyName - Property name

Returns:

Enum value

getExclusionRule

public InclusionRule getExclusionRule(String optionName)

getInclusionRule

public InclusionRule getInclusionRule(String optionName)

getInclusionRule

public InclusionRule getInclusionRule(String includePatternProperty,
                                      String excludePatternProperty)

getInclusionRuleDefaultExclude

public InclusionRule getInclusionRuleDefaultExclude(String includePatternProperty,
                                                    String excludePatternProperty)

getInclusionRuleOrNull

public InclusionRule getInclusionRuleOrNull(String includePatternProperty,
                                            String excludePatternProperty)

getIntegerValue

public int getIntegerValue(String propertyName,
                           int defaultValue)

Gets the value of a property as an integer.

Parameters:

propertyName - Property name

Returns:

Integer value

getLongValue

public long getLongValue(String propertyName,
                         long defaultValue)

Gets the value of a property as an long.

Parameters:

propertyName - Property name

Returns:

Long value

getStringValue

public String getStringValue(String propertyName,
                             String defaultValue)

Gets the value of a property as a string.

Parameters:

propertyName - Property name

defaultValue - Default value

Returns:

String value

hasValue

public boolean hasValue(String propertyName)

Checks if a value is available.

Parameters:

propertyName - Property name

Returns:

True if a value ia available.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,String>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,String>

put

public String put(String key,
                  String value)

Specified by:

put in interface Map<String,String>

putAll

public void putAll(Map<? extends String,? extends String> m)

Specified by:

putAll in interface Map<String,String>

remove

public String remove(Object key)

Specified by:

remove in interface Map<String,String>

setBooleanValue

public void setBooleanValue(String propertyName,
                            boolean value)

setEnumValue

public <E extends Enum<E>> void setEnumValue(String propertyName,
                                             E value)

setStringValue

public void setStringValue(String propertyName,
                           String value)

size

public int size()

Specified by:

size in interface Map<String,String>

toString

public String toString()

Overrides:

toString in class Object

values

public Collection<String> values()

Specified by:

values in interface Map<String,String>