Uses of Class
com.ultikits.ultitools.config.document.ConfigDocument

Packages that use ConfigDocument

Package	Description
com.ultikits.ultitools
com.ultikits.ultitools.abstracts
com.ultikits.ultitools.config.document	The config storage layer: a config file as a document over SnakeYAML's node tree, the plain-data boundary every value crosses before it reaches a file, the configuration write gate (OperatorFileWriter) every write to an operator-editable configuration file goes through, and the atomic writer that publishes what the gate verified.
com.ultikits.ultitools.utils

Uses of ConfigDocument in com.ultikits.ultitools

Methods in com.ultikits.ultitools with parameters of type ConfigDocument

Modifier and Type	Method	Description
private static void	UltiTools.addIfAbsent(ConfigDocument document, org.bukkit.configuration.file.YamlConfiguration server, Map<List<String>,Object> missing, Map<List<String>,List<String>> comments, String dottedPath, Object value, List<String> commentLines)	Records dottedPath (framework keys, no key contains a dot) as missing when neither the document nor the server's Bukkit reading of the same bytes holds it (a flat dotted key is present only in the latter).

Method parameters in com.ultikits.ultitools with type arguments of type ConfigDocument

Modifier and Type	Method	Description
private static String	UltiTools.keyBukkitWouldReadDifferently(File configFile, String fingerprint, org.bukkit.configuration.file.YamlConfiguration before, Consumer<ConfigDocument> insert)	Renders insert on a fresh copy of the file and reads the result the way the server does: the first key whose value Bukkit would read differently than before does, or null when every existing key reads the same.

Uses of ConfigDocument in com.ultikits.ultitools.abstracts

Fields in com.ultikits.ultitools.abstracts declared as ConfigDocument

Modifier and Type	Field	Description
private ConfigDocument	AbstractConfigEntity.document
private final ConfigDocument	AbstractConfigEntity.PanelCheckpoint.oldDocument
private final ConfigDocument	AbstractConfigEntity.PendingInitialization.read

Methods in com.ultikits.ultitools.abstracts with parameters of type ConfigDocument

Modifier and Type	Method	Description
private void	AbstractConfigEntity.acknowledgeRaw(ConfigDocument source, List<Field> fields)
private void	AbstractConfigEntity.acknowledgeWritten(String readFingerprint, String fingerprint, ConfigDocument onDisk, List<AbstractConfigEntity.ModuleChange> applied)	Advances the effective baseline and the last-read entry of exactly the changes the file now holds.
private boolean	AbstractConfigEntity.addEntryComment(ConfigDocument target, Field field)	Writes the framework's comment above field's key in target: for a token comment, only the run of comment lines AbstractConfigEntity.frameworkCommentRun(com.ultikits.ultitools.config.document.ConfigDocument, java.lang.reflect.Field) identifies as the framework's is replaced, and a comment that is the operator's is left as it is; a literal comment is written only for a key just inserted, which has no comment yet.
private static void	AbstractConfigEntity.apply(ConfigDocument target, List<AbstractConfigEntity.ModuleChange> changes)	Sets the module's value, or removes the map entry the module removed, at each change's path.
private int	AbstractConfigEntity.frameworkCommentRun(ConfigDocument target, Field field)	How many of the last comment lines above field's key in target the framework wrote (#604, maintainer decision 2026-10-04: "only the framework's own comments are rewritten").
private boolean	AbstractConfigEntity.heldTwice(ConfigDocument doc, Field field)	Whether doc holds field's setting in more than one form (#612).
private List<String>	AbstractConfigEntity.insertKeysIn(ConfigDocument doc, Field field)	Where an insert puts field's setting, which doc does not hold (#614, maintainer decision 2026-10-06): below the longest prefix of its path the file holds as a section (heldSections(java.lang.String)), the rest of the path as nested keys - so a section the operator wrote in flat dotted form (a.b:) gets the setting in place, never a second, nested copy of the section.
private List<String>	AbstractConfigEntity.keysIn(ConfigDocument doc, Field field)	Where doc holds field's setting: its one reading (readings(String)) - the nested keys, a flat dotted key such as features.chat, or a mix such as a.b: {c: 1} - or, when it holds none, where an insert puts it (AbstractConfigEntity.insertKeysIn(com.ultikits.ultitools.config.document.ConfigDocument, java.lang.reflect.Field); the nested keys when that cannot be decided, for a caller that only asks whether the setting is held).
private void	AbstractConfigEntity.ownFrameworkComments(OwnedPaths.Builder owned, ConfigDocument read)	The token comments of read the framework may rewrite, each owning only the run of lines AbstractConfigEntity.frameworkCommentRun(com.ultikits.ultitools.config.document.ConfigDocument, java.lang.reflect.Field) identified as the framework's in the file as read (#604): the config write gate then refuses any write that changes a comment line above that run or of a comment that is the operator's.
private AbstractConfigEntity.Placement	AbstractConfigEntity.placement(ConfigDocument doc, Field field)
private void	AbstractConfigEntity.refuseSeveralSpellings(ConfigDocument read, Field field)	An operator write of a setting whose typed map keys read holds in several spellings is refused.
private boolean	AbstractConfigEntity.reportedSeveralSpellings(ConfigDocument read, Field field, List<List<String>> leaves)	The save rule for a setting whose typed map keys read holds in several spellings: none of its changed leaves is written, and one warning names them with the reason, never a value.
private static OwnedPaths	AbstractConfigEntity.saveOwnership(List<AbstractConfigEntity.ModuleChange> changes, ConfigDocument read)	What a save owns at the config write gate: each change's whole key, except that a map which is empty in the file as read ({}), or which the changes empty, is owned as a whole - its key line must change with its first or last entry, and an empty map holds nothing of the operator's that could be lost.
private List<String>	AbstractConfigEntity.sectionHoldingASibling(ConfigDocument doc, Field field, List<List<String>> sections)	Of several forms of one section, the one form holding another declared setting of it; null for none or several.
private List<List<String>>	AbstractConfigEntity.severalSpellings(ConfigDocument read, Field field)	Every typed map key that read holds for field in several spellings, relative to the setting and ending in its first spelling in file order (#673, case 52).
private boolean	AbstractConfigEntity.tokenCommentsDiffer(ConfigDocument target)	Whether a framework token comment in target differs from what the current language renders, without changing target: the framework's own run (AbstractConfigEntity.frameworkCommentRun(com.ultikits.ultitools.config.document.ConfigDocument, java.lang.reflect.Field)) compared, in its written byte form, with the current rendering; a comment that is the operator's never differs.
private String	AbstractConfigEntity.unplacedReason(ConfigDocument doc, Field field)	Why field's setting cannot be inserted (AbstractConfigEntity.insertKeysIn(com.ultikits.ultitools.config.document.ConfigDocument, java.lang.reflect.Field) returned null): names, never values.
private boolean	AbstractConfigEntity.updateTokenComments(ConfigDocument target)
private OperatorFileWriter.Result	AbstractConfigEntity.writeInitialization(Map<Field,Object> inserted, String expected, ConfigDocument read)	Writes an initialization - the declared keys init found missing, each with its comment, and the framework's token comments - through the config write gate (OperatorFileWriter), at once or from the batch flush.

Constructors in com.ultikits.ultitools.abstracts with parameters of type ConfigDocument

Modifier	Constructor	Description
private	PendingInitialization(ConfigDocument read, Map<Field,Object> baseline, Map<Field,Object> inserted, String expected)
private	RawEntry(ConfigDocument source, List<String> path)

Uses of ConfigDocument in com.ultikits.ultitools.config.document

Fields in com.ultikits.ultitools.config.document declared as ConfigDocument

Modifier and Type	Field	Description
private ConfigDocument	OperatorFileWriter.Snapshot.candidate
private final ConfigDocument	OperatorFileWriter.Staged.candidate
private final ConfigDocument	ConfigLoadResult.document
private final ConfigDocument	OperatorFileWriter.Result.document
private final ConfigDocument	OperatorFileWriter.Side.document
private ConfigDocument	OperatorFileWriter.Snapshot.original

Methods in com.ultikits.ultitools.config.document that return ConfigDocument

Modifier and Type	Method	Description
ConfigDocument	ConfigLoadResult.document()	The parsed document.
ConfigDocument	OperatorFileWriter.Result.document()	The edited document, which is what the file now holds, for OperatorFileWriter.Outcome.WRITTEN and OperatorFileWriter.Outcome.UNCHANGED; null otherwise.
static ConfigDocument	ConfigDocument.empty()	Returns an empty document, as for a file that does not exist yet, in the default style.
static ConfigDocument	ConfigDocument.parse(String text)	Parses a config file's text.
private static ConfigDocument	OperatorFileWriter.parseOrNull(String text)

Methods in com.ultikits.ultitools.config.document with parameters of type ConfigDocument

Modifier and Type	Method	Description
private static int	OperatorFileWriter.commentLineCount(ConfigDocument document, List<String> path)	How many lines directly above the key at path are its own comment in document: the comment lines blockComment(List) reports, without the blank lines above them (those are kept by every comment write).
(package private) static ConfigLoadResult	ConfigLoadResult.loaded(Path file, ConfigDocument document, String fingerprint)
private static List<String>	OperatorFileWriter.EmptySections.nearestHeldAncestor(ConfigDocument original, List<String> path)
(package private) static OperatorFileWriter.Changes	OperatorFileWriter.Changes.of(ConfigDocument original, ConfigDocument candidate, OwnedPaths owned)
(package private) static OperatorFileWriter.EmptySections	OperatorFileWriter.EmptySections.of(String text, ConfigDocument original, ConfigDocument candidate, OperatorFileWriter.Changes changes)
private static List<String>	OperatorFileWriter.topmostAbsentPrefix(ConfigDocument original, List<String> path)
private static String	OperatorFileWriter.verify(String text, String rendered, ConfigDocument original, ConfigDocument candidate, OperatorFileWriter.Changes changes, OwnedPaths owned, List<List<String>> expanded)
private static String	OperatorFileWriter.verifyValues(ConfigDocument original, ConfigDocument candidate, String rendered, List<List<String>> changedValues, List<List<String>> expanded, boolean wholeFile)	Check 1: the rendered text holds exactly the edited values, and the edit stayed inside its paths.
private static OperatorFileWriter.Result	OperatorFileWriter.written(String rendered, ConfigDocument candidate, String read)

Method parameters in com.ultikits.ultitools.config.document with type arguments of type ConfigDocument

Modifier and Type	Method	Description
static OperatorFileWriter.Staged	OperatorFileWriter.stage(Path file, OwnedPaths owned, String expectedFingerprint, Consumer<ConfigDocument> edit)	As OperatorFileWriter.write(Path, OwnedPaths, String, Consumer), but stops once the verified content is staged (written and forced to a temporary file beside the target), so several files can be prepared before any of them is replaced.
(package private) static OperatorFileWriter.Staged	OperatorFileWriter.stage(Path file, OwnedPaths owned, String expectedFingerprint, Consumer<ConfigDocument> edit, AtomicConfigWriter.FileOperations files)
private static List<String>	OperatorFileWriter.wouldChange(OperatorFileWriter.Snapshot snapshot, OwnedPaths owned, Consumer<ConfigDocument> edit)	For a write that cannot start because the file changed: what it would have changed in the file as it is now, to name in the warning; empty when that cannot be told.
static OperatorFileWriter.Result	OperatorFileWriter.write(Path file, OwnedPaths owned, String expectedFingerprint, Consumer<ConfigDocument> edit)	Applies edit to the file as it is now and publishes the result only when every byte outside owned stays as it is (see the class description for why this cannot overwrite operator content).
(package private) static OperatorFileWriter.Result	OperatorFileWriter.write(Path file, OwnedPaths owned, String expectedFingerprint, Consumer<ConfigDocument> edit, AtomicConfigWriter.FileOperations files)	As OperatorFileWriter.write(Path, OwnedPaths, String, Consumer), with the publication steps as a test seam (null: real).

Constructors in com.ultikits.ultitools.config.document with parameters of type ConfigDocument

Modifier	Constructor	Description
private	ConfigLoadResult(Path file, ConfigLoadResult.State state, ConfigDocument document, String fingerprint, IOException cause, String parserMessage)
private	Result(OperatorFileWriter.Outcome outcome, String reason, ConfigDocument document)
private	Result(OperatorFileWriter.Outcome outcome, String reason, ConfigDocument document, String fingerprint, String readFingerprint)
(package private)	Side(ConfigDocument document, org.yaml.snakeyaml.nodes.Node tree, List<String> lines)
private	Staged(Path file, Path absolute, OwnedPaths owned, List<String> keys, String rendered, ConfigDocument candidate, String read, String readText, AtomicConfigWriter.StagedWrite temporary)

Uses of ConfigDocument in com.ultikits.ultitools.utils

Methods in com.ultikits.ultitools.utils with parameters of type ConfigDocument

Modifier and Type	Method	Description
(package private) static List<RemoteConfigEntries.Entry>	RemoteConfigEntries.describe(AbstractConfigEntity entity, ConfigDocument document)	Builds the editable entries of one file as it is on disk.