io.github.cdimascio.dotenv

Class Dotenv

io.github.cdimascio.dotenv.Dotenv

public class Dotenv

Dotenv

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dotenv.Instance The dotenv instance

Field Summary

Fields

Modifier and Type	Field and Description
static Dotenv.Instance	Instance The dotenv instance

Constructor Summary

Constructors

Constructor and Description
Dotenv() Dotenv

Method Summary

Modifier and Type	Method and Description
static DotenvBuilder	configure() Configure dotenv
java.util.Set<io.github.cdimascio.dotenv.DotenvEntry>	entries() Returns all environment entries
java.util.Set<io.github.cdimascio.dotenv.DotenvEntry>	entries(DotenvEntriesFilter filter) Returns all environment entries filtered by {@link DotenvEntriesFilter}
java.lang.String	get(java.lang.String envName) Returns the value for the specified environment variable
java.lang.String	get(java.lang.String envName, java.lang.String defValue) Returns the value for the environment variable, or the default value if absent
static Dotenv	load() Load the the contents of .env into the virtual environment. Environment variables in the host environment override those in .env

Field Detail

Instance

public static Dotenv.Instance Instance

The dotenv instance

Constructor Detail

Dotenv

public Dotenv()

Dotenv

Method Detail

get

@Nullable
public java.lang.String get(@NotNull
                                      java.lang.String envName)

Returns the value for the specified environment variable

Parameters:

envName - The environment variable name

entries

@NotNull
public java.util.Set<io.github.cdimascio.dotenv.DotenvEntry> entries()

Returns all environment entries

entries

@NotNull
public java.util.Set<io.github.cdimascio.dotenv.DotenvEntry> entries(@NotNull
                                                                              DotenvEntriesFilter filter)

Returns all environment entries filtered by {@link DotenvEntriesFilter}

get

@NotNull
public java.lang.String get(@NotNull
                                     java.lang.String envName,
                                     @NotNull
                                     java.lang.String defValue)

Returns the value for the environment variable, or the default value if absent

Parameters:

envName - The environment variable name

defValue - The default value

configure

@JvmStatic
 @NotNull
public static DotenvBuilder configure()

Configure dotenv

Returns:

A dotenv builder

load

@JvmStatic
 @NotNull
public static Dotenv load()

Load the the contents of .env into the virtual environment. Environment variables in the host environment override those in .env