file

fun file(file: File, optional: Boolean = this.optional): Config
Content copied to clipboard

Returns a child config containing values from specified file.

Format of the file is auto-detected from the file extension. Supported file formats and the corresponding extensions:

  • HOCON: conf

  • JSON: json

  • Properties: properties

  • TOML: toml

  • XML: xml

  • YAML: yml, yaml

Throws UnsupportedExtensionException if the file extension is unsupported.

Return

a child config containing values from specified file

Parameters

file

specified file

optional

whether the source is optional

Throws

fun file(file: String, optional: Boolean = this.optional): Config
Content copied to clipboard

Returns a child config containing values from specified file path.

Format of the file is auto-detected from the file extension. Supported file formats and the corresponding extensions:

  • HOCON: conf

  • JSON: json

  • Properties: properties

  • TOML: toml

  • XML: xml

  • YAML: yml, yaml

Throws UnsupportedExtensionException if the file extension is unsupported.

Return

a child config containing values from specified file path

Parameters

file

specified file path

optional

whether the source is optional

Throws