Package com.ultikits.ultitools.config.document

Class ConfigLoadResult

java.lang.Object

com.ultikits.ultitools.config.document.ConfigLoadResult

@Internal
public final class ConfigLoadResult
extends Object

What reading one config file found. ConfigDocument.load(Path) returns one of four states and never throws, so a file that exists but cannot be read or parsed is never mistaken for a missing file - the distinction that keeps the framework from overwriting an operator's broken file with defaults (UltiKits/UltiTools-Reborn#511, #470).

Since:

6.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ConfigLoadResult.State	The four outcomes of a load.

Field Summary

Fields

Modifier and Type	Field	Description
private final IOException	cause
private final ConfigDocument	document
private final Path	file
private final String	fingerprint
private static final Pattern	PARSER_LOCATION
private final String	parserLocation
private final String	parserMessage
private final ConfigLoadResult.State	state

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ConfigLoadResult(Path file, ConfigLoadResult.State state, ConfigDocument document, String fingerprint, IOException cause, String parserMessage, String parserLocation)

Method Summary

Modifier and Type	Method	Description
(package private) static ConfigLoadResult	absent(Path file)
IOException	cause()	Why the file could not be read.
ConfigDocument	document()	The parsed document.
Path	file()	The file that was read.
String	fingerprint()	The SHA-256 of the bytes read, as 64 lower-case hex digits, so a later write can tell whether the file changed on disk since it was read.
(package private) static ConfigLoadResult	loaded(Path file, ConfigDocument document, String fingerprint)
String	parserMessage()	Why the file could not be parsed: the parser's own message, naming the line and column.
String	safeParserLocation()	A value-safe parse diagnostic shared by configuration loads, reloads and migration.
private static String	safeParserLocation(Throwable failure, String message)	Extracts only numeric metadata while the typed parser failure is still available.
ConfigLoadResult.State	state()	The outcome.
String	toString()
(package private) static ConfigLoadResult	unparseable(Path file, String parserMessage)
(package private) static ConfigLoadResult	unparseable(Path file, String parserMessage, Throwable parserFailure)
(package private) static ConfigLoadResult	unreadable(Path file, IOException cause)

Methods inherited from class java.lang.Object

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

Field Details

PARSER_LOCATION

private static final Pattern PARSER_LOCATION

file

private final Path file

state

private final ConfigLoadResult.State state

document

private final ConfigDocument document

fingerprint

private final String fingerprint

cause

private final IOException cause

parserMessage

private final String parserMessage

parserLocation

private final String parserLocation

Constructor Details

ConfigLoadResult

private ConfigLoadResult(Path file,
 ConfigLoadResult.State state,
 ConfigDocument document,
 String fingerprint,
 IOException cause,
 String parserMessage,
 String parserLocation)

Method Details

absent

static ConfigLoadResult absent(Path file)

loaded

static ConfigLoadResult loaded(Path file,
 ConfigDocument document,
 String fingerprint)

unreadable

static ConfigLoadResult unreadable(Path file,
 IOException cause)

unparseable

static ConfigLoadResult unparseable(Path file,
 String parserMessage)

unparseable

static ConfigLoadResult unparseable(Path file,
 String parserMessage,
 Throwable parserFailure)

safeParserLocation

private static String safeParserLocation(Throwable failure,
 String message)

Extracts only numeric metadata while the typed parser failure is still available.

file

public Path file()

The file that was read.

Returns:

the path as passed to load

state

public ConfigLoadResult.State state()

The outcome.

Returns:

the state

document

public ConfigDocument document()

The parsed document.

Returns:

the document when ConfigLoadResult.State.LOADED, otherwise null

fingerprint

public String fingerprint()

The SHA-256 of the bytes read, as 64 lower-case hex digits, so a later write can tell whether the file changed on disk since it was read.

Returns:

the fingerprint when ConfigLoadResult.State.LOADED, otherwise null

cause

public IOException cause()

Why the file could not be read.

Returns:

the I/O failure when ConfigLoadResult.State.UNREADABLE, otherwise null

parserMessage

public String parserMessage()

Why the file could not be parsed: the parser's own message, naming the line and column.

Returns:

the message when ConfigLoadResult.State.UNPARSEABLE, otherwise null

safeParserLocation

public String safeParserLocation()

A value-safe parse diagnostic shared by configuration loads, reloads and migration. The typed parser problem mark takes precedence over text metadata; no raw exception is retained.

Returns:

the one-based problem line and column, or a generic YAML/UTF-8 failure category

toString

public String toString()

Overrides:

toString in class Object