PklSettings (pkl-core 0.25.2 API)

java.lang.Object
- org.pkl.core.settings.PklSettings

```
public final class PklSettings
extends java.lang.Object
```
Java representation of a Pkl settings file. A Pkl settings file is a Pkl module amending the pkl.settings standard library module. To load a settings file, use one of the static load methods.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PklSettings.Editor
An editor for viewing and editing Pkl files.

Constructor Summary

Constructors
Constructor Description

PklSettings(PklSettings.Editor editor)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(@Nullable java.lang.Object o)`
`PklSettings.Editor`	`getEditor()`	Returns the editor for viewing and editing Pkl files.
`int`	`hashCode()`
`static PklSettings`	`load(ModuleSource moduleSource)`	Loads a settings file from the given path.
`static PklSettings`	`loadFromPklHomeDir()`	Loads the user settings file (~/.pkl/settings.pkl).
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PklSettings
```
public PklSettings(PklSettings.Editor editor)
```
- Method Detail
  - loadFromPklHomeDir
```
public static PklSettings loadFromPklHomeDir()
                                      throws VmEvalException
```
    Loads the user settings file (~/.pkl/settings.pkl). If this file does not exist, returns default settings defined by module pkl.settings.
    
    Throws:
    
    VmEvalException
  - load
```
public static PklSettings load(ModuleSource moduleSource)
                        throws VmEvalException
```
    Loads a settings file from the given path.
    
    Throws:
    
    VmEvalException
  - getEditor
```
public PklSettings.Editor getEditor()
```
    Returns the editor for viewing and editing Pkl files.
  - equals
```
public boolean equals(@Nullable java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object