Package io.github.cdimascio.dotenv

Class DotenvBuilder

java.lang.Object

io.github.cdimascio.dotenv.DotenvBuilder

public class DotenvBuilder
extends Object

Builds and loads and Dotenv instance.

See Also:

Dotenv.configure()

Constructor Summary

Constructors

Constructor	Description
DotenvBuilder()

Method Summary

Modifier and Type	Method	Description
DotenvBuilder	directory(String path)	Sets the directory containing the .env file.
DotenvBuilder	filename(String name)	Sets the name of the .env file.
DotenvBuilder	ignoreIfMalformed()	Does not throw an exception when .env is malformed.
DotenvBuilder	ignoreIfMissing()	Does not throw an exception when .env is missing.
Dotenv	load()	Load the contents of .env into the virtual environment.
DotenvBuilder	systemProperties()	Sets each environment variable as system properties.

Methods inherited from class java.lang.Object

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

Constructor Details

DotenvBuilder

public DotenvBuilder()

Method Details

directory

public DotenvBuilder directory(String path)

Sets the directory containing the .env file.

Parameters:

path - the directory containing the .env file

Returns:

this DotenvBuilder

filename

public DotenvBuilder filename(String name)

Sets the name of the .env file. The default is .env.

Parameters:

name - the filename

Returns:

this DotenvBuilder

ignoreIfMissing

public DotenvBuilder ignoreIfMissing()

Does not throw an exception when .env is missing.

Returns:

this DotenvBuilder

ignoreIfMalformed

public DotenvBuilder ignoreIfMalformed()

Does not throw an exception when .env is malformed.

Returns:

this DotenvBuilder

systemProperties

public DotenvBuilder systemProperties()

Sets each environment variable as system properties.

Returns:

this DotenvBuilder

load

public Dotenv load()
            throws DotenvException

Load the contents of .env into the virtual environment.

Returns:

a new Dotenv instance

Throws:

DotenvException - when an error occurs