com.github.susom.database

Interface Config

All Superinterfaces:

Function<String,String>, Supplier<Config>

All Known Implementing Classes:

ConfigImpl

public interface Config
extends Function<String,String>, Supplier<Config>

Entry point for getting configuration parameters. This isn't intended as a be-all, end-all configuration solution. Just a way of easily specifying multiple read-only sources for configuration with a nice fluent syntax.

Author:

garricko

Method Summary

Modifier and Type	Method and Description
default String	apply(String key) Same as getString(String).
static ConfigFrom	from() Convenience method for fluent syntax.
default Config	get()
BigDecimal	getBigDecimal(String key)
BigDecimal	getBigDecimal(String key, BigDecimal defaultValue)
BigDecimal	getBigDecimalOrThrow(String key)
boolean	getBooleanOrFalse(String key) Read a boolean value from the configuration.
boolean	getBooleanOrThrow(String key)
boolean	getBooleanOrTrue(String key) Read a boolean value from the configuration.
Double	getDouble(String key)
double	getDouble(String key, double defaultValue)
double	getDoubleOrThrow(String key)
Float	getFloat(String key)
float	getFloat(String key, float defaultValue)
float	getFloatOrThrow(String key)
Integer	getInteger(String key)
int	getInteger(String key, int defaultValue)
int	getIntegerOrThrow(String key)
Long	getLong(String key)
long	getLong(String key, long defaultValue)
long	getLongOrThrow(String key)
String	getString(String key)
String	getString(String key, String defaultValue)
String	getStringOrThrow(String key)
String	sources() Show where configuration is coming from.

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Method Detail

from

@Nonnull
static ConfigFrom from()

Convenience method for fluent syntax.

Returns:

a builder for specifying from where configuration should be loaded

getString

@Nullable
String getString(@Nonnull
                           String key)

Returns:

a trimmed, non-empty string, or null

getStringOrThrow

@Nonnull
String getStringOrThrow(@Nonnull
                                 String key)

Returns:

a trimmed, non-empty string

Throws:

ConfigMissingException - if no value could be read for the specified key

getString

@Nonnull
String getString(String key,
                          @Nonnull
                          String defaultValue)

apply

default String apply(String key)

Same as getString(String). Useful for passing configs around without static dependencies.

Specified by:

apply in interface Function<String,String>

get

default Config get()

Specified by:

get in interface Supplier<Config>

getInteger

@Nullable
Integer getInteger(@Nonnull
                             String key)

getInteger

int getInteger(@Nonnull
               String key,
               int defaultValue)

getIntegerOrThrow

int getIntegerOrThrow(@Nonnull
                      String key)

Throws:

ConfigMissingException - if no value could be read for the specified key

getLong

@Nullable
Long getLong(@Nonnull
                       String key)

getLong

long getLong(@Nonnull
             String key,
             long defaultValue)

getLongOrThrow

long getLongOrThrow(@Nonnull
                    String key)

Throws:

ConfigMissingException - if no value could be read for the specified key

getFloat

@Nullable
Float getFloat(@Nonnull
                         String key)

getFloat

float getFloat(@Nonnull
               String key,
               float defaultValue)

getFloatOrThrow

float getFloatOrThrow(@Nonnull
                      String key)

Throws:

ConfigMissingException - if no value could be read for the specified key

getDouble

@Nullable
Double getDouble(@Nonnull
                           String key)

getDouble

double getDouble(@Nonnull
                 String key,
                 double defaultValue)

getDoubleOrThrow

double getDoubleOrThrow(@Nonnull
                        String key)

Throws:

ConfigMissingException - if no value could be read for the specified key

getBigDecimal

@Nullable
BigDecimal getBigDecimal(@Nonnull
                                   String key)

getBigDecimal

@Nonnull
BigDecimal getBigDecimal(String key,
                                  @Nonnull
                                  BigDecimal defaultValue)

getBigDecimalOrThrow

@Nonnull
BigDecimal getBigDecimalOrThrow(String key)

Throws:

ConfigMissingException - if no value could be read for the specified key

getBooleanOrFalse

boolean getBooleanOrFalse(@Nonnull
                          String key)

Read a boolean value from the configuration. The value is not case-sensitivie, and may be either true/false or yes/no. If no value was provided or an invalid value is provided, false will be returned.

getBooleanOrTrue

boolean getBooleanOrTrue(@Nonnull
                         String key)

Read a boolean value from the configuration. The value is not case-sensitivie, and may be either true/false or yes/no. If no value was provided or an invalid value is provided, true will be returned.

getBooleanOrThrow

boolean getBooleanOrThrow(@Nonnull
                          String key)

Throws:

ConfigMissingException - if no value could be read for the specified key

sources

String sources()

Show where configuration is coming from. This is useful to drop in your logs for troubleshooting.