schemacrawler.schemacrawler

Class Config

java.lang.Object

schemacrawler.schemacrawler.Config

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.String>, Options

public final class Config
extends java.lang.Object
implements Options, java.util.Map<java.lang.String,java.lang.String>

Configuration properties.

Author:

Sualeh Fatehi

Nested Class Summary

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	entrySet()
java.lang.String	get(java.lang.Object key)
boolean	getBooleanValue(java.lang.String propertyName) Gets the value of a property as a boolean.
boolean	getBooleanValue(java.lang.String propertyName, boolean defaultValue)
double	getDoubleValue(java.lang.String propertyName, double defaultValue) Gets the value of a property as an double.
<E extends java.lang.Enum<E>> E	getEnumValue(java.lang.String propertyName, E defaultValue) Gets the value of a property as an enum.
InclusionRule	getExclusionRule(java.lang.String optionName) Creates an exclusion rule, which includes everything, and then excludes a pattern.
InclusionRule	getInclusionRule(java.lang.String optionName) Creates an inclusion rule, which includes a pattern has no excludes.
InclusionRule	getInclusionRuleWithDefault(java.lang.String includePatternProperty, java.lang.String excludePatternProperty, java.util.function.Supplier<InclusionRule> supplier)
int	getIntegerValue(java.lang.String propertyName, int defaultValue) Gets the value of a property as an integer.
long	getLongValue(java.lang.String propertyName, long defaultValue) Gets the value of a property as an long.
java.util.Optional<InclusionRule>	getOptionalInclusionRule(java.lang.String includePatternProperty, java.lang.String excludePatternProperty)
java.lang.String	getStringValue(java.lang.String propertyName, java.lang.String defaultValue) Gets the value of a property as a string.
boolean	hasValue(java.lang.String propertyName) Checks if a value is available.
boolean	isEmpty()
java.util.Set<java.lang.String>	keySet()
java.lang.String	put(java.lang.String key, java.lang.String value)
void	putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> m)
void	putAll(java.util.Properties properties)
java.lang.String	remove(java.lang.Object key)
void	setBooleanValue(java.lang.String propertyName, boolean value)
<E extends java.lang.Enum<E>> void	setEnumValue(java.lang.String propertyName, E value)
void	setStringValue(java.lang.String propertyName, java.lang.String value)
int	size()
java.util.Properties	toProperties() Convert config to Properties
java.lang.String	toString()
java.util.Collection<java.lang.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(java.util.Map<java.lang.String,java.lang.String> config)

Copies config into a map.

Parameters:

config - Config to copy

Config

public Config(java.util.Properties properties)

Copies properties into a map.

Parameters:

properties - Properties to copy

Method Detail

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.String>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.String>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.lang.String>

entrySet

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

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.lang.String>

get

public java.lang.String get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.String>

getBooleanValue

public boolean getBooleanValue(java.lang.String propertyName)

Gets the value of a property as a boolean.

Parameters:

propertyName - Property name

Returns:

Boolean value

getBooleanValue

public boolean getBooleanValue(java.lang.String propertyName,
                               boolean defaultValue)

getDoubleValue

public double getDoubleValue(java.lang.String propertyName,
                             double defaultValue)

Gets the value of a property as an double.

Parameters:

propertyName - Property name

Returns:

Double value

getEnumValue

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

Gets the value of a property as an enum.

Parameters:

propertyName - Property name

Returns:

Enum value

getExclusionRule

public InclusionRule getExclusionRule(java.lang.String optionName)

Creates an exclusion rule, which includes everything, and then excludes a pattern. If no pattern is provided, include everything, since there are no excludes specified.

Parameters:

optionName - Option to look up.

Returns:

Inclusion rule.

getInclusionRule

public InclusionRule getInclusionRule(java.lang.String optionName)

Creates an inclusion rule, which includes a pattern has no excludes. If no pattern is provided, exclude everything, since there are no includes specified.

Parameters:

optionName - Option to look up.

Returns:

Inclusion rule.

getInclusionRuleWithDefault

public InclusionRule getInclusionRuleWithDefault(java.lang.String includePatternProperty,
                                                 java.lang.String excludePatternProperty,
                                                 java.util.function.Supplier<InclusionRule> supplier)

getIntegerValue

public int getIntegerValue(java.lang.String propertyName,
                           int defaultValue)

Gets the value of a property as an integer.

Parameters:

propertyName - Property name

Returns:

Integer value

getLongValue

public long getLongValue(java.lang.String propertyName,
                         long defaultValue)

Gets the value of a property as an long.

Parameters:

propertyName - Property name

Returns:

Long value

getOptionalInclusionRule

public java.util.Optional<InclusionRule> getOptionalInclusionRule(java.lang.String includePatternProperty,
                                                                  java.lang.String excludePatternProperty)

getStringValue

public java.lang.String getStringValue(java.lang.String propertyName,
                                       java.lang.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(java.lang.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 java.util.Map<java.lang.String,java.lang.String>

keySet

public java.util.Set<java.lang.String> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.String,java.lang.String>

put

public java.lang.String put(java.lang.String key,
                            java.lang.String value)

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.String>

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> m)

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.String>

putAll

public void putAll(java.util.Properties properties)

remove

public java.lang.String remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.String>

setBooleanValue

public void setBooleanValue(java.lang.String propertyName,
                            boolean value)

setEnumValue

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

setStringValue

public void setStringValue(java.lang.String propertyName,
                           java.lang.String value)

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,java.lang.String>

toProperties

public java.util.Properties toProperties()

Convert config to Properties

Returns:

Properties

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

values

public java.util.Collection<java.lang.String> values()

Specified by:

values in interface java.util.Map<java.lang.String,java.lang.String>