Uses of Class
com.ultikits.ultitools.config.document.OwnedPaths
Packages that use OwnedPaths
Package
Description
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.-
Uses of OwnedPaths in com.ultikits.ultitools.abstracts
Methods in com.ultikits.ultitools.abstracts that return OwnedPathsModifier and TypeMethodDescriptionprivate static OwnedPathsAbstractConfigEntity.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. -
Uses of OwnedPaths in com.ultikits.ultitools.config.document
Fields in com.ultikits.ultitools.config.document declared as OwnedPathsModifier and TypeFieldDescriptionprivate final OwnedPathsOperatorFileWriter.Staged.ownedprivate static final OwnedPathsOwnedPaths.WHOLE_FILEMethods in com.ultikits.ultitools.config.document that return OwnedPathsModifier and TypeMethodDescriptionOwnedPaths.Builder.build()Builds the immutable description.static OwnedPathsOwnedPaths.wholeFile()The whole file, for creating a file that does not exist.Methods in com.ultikits.ultitools.config.document with parameters of type OwnedPathsModifier and TypeMethodDescriptionprivate static OperatorFileWriter.Resultprivate voidOperatorFileWriter.Snapshot.checkPreconditions(OwnedPaths owned, String expectedFingerprint) private static OperatorFileWriter.ResultOperatorFileWriter.fail(OperatorFileWriter.Outcome outcome, Path absolute, OwnedPaths owned, List<String> keys, String reason) private static StringOperatorFileWriter.markSpans(OperatorFileWriter.Side left, OperatorFileWriter.Side right, OperatorFileWriter.Changes changes, OwnedPaths owned) Checks 2 and 5: marks every owned span on both sides, refusing a span that shares a line with an unowned key.(package private) static OperatorFileWriter.ChangesOperatorFileWriter.Changes.of(ConfigDocument original, ConfigDocument candidate, OwnedPaths owned) private static int[]OperatorFileWriter.ownedCommentLines(OwnedPaths owned, OperatorFileWriter.Side left, OperatorFileWriter.Side right, List<String> path) The owned comment lines directly above the key atpath, before and after the edit: the whole comment, or - for a framework comment run - the run's length in the file as read and the length of what replaced it.(package private) static OperatorFileWriter.SnapshotOperatorFileWriter.Snapshot.read(Path file, OwnedPaths owned, String expectedFingerprint) private static OperatorFileWriter.Resultprivate static OperatorFileWriter.ResultOperatorFileWriter.refuseAnchored(Path absolute, OwnedPaths owned) An anchored file is refused on every write but named once per file per server run.private static StringOperatorFileWriter.runtimeFailure(OwnedPaths owned, String step, RuntimeException failure) The refusal reason for a runtime failure inside a gated write (#624): the keys, the step that failed and the failure's class, never a value.static OperatorFileWriter.StagedOperatorFileWriter.stage(Path file, OwnedPaths owned, String expectedFingerprint, Consumer<ConfigDocument> edit) AsOperatorFileWriter.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.StagedOperatorFileWriter.stage(Path file, OwnedPaths owned, String expectedFingerprint, Consumer<ConfigDocument> edit, AtomicConfigWriter.FileOperations files) private static StringOperatorFileWriter.verify(String text, String rendered, ConfigDocument original, ConfigDocument candidate, OperatorFileWriter.Changes changes, OwnedPaths owned, List<List<String>> expanded) private static voidOperatorFileWriter.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.ResultOperatorFileWriter.write(Path file, OwnedPaths owned, String expectedFingerprint, Consumer<ConfigDocument> edit) Applieseditto the file as it is now and publishes the result only when every byte outsideownedstays as it is (see the class description for why this cannot overwrite operator content).(package private) static OperatorFileWriter.ResultOperatorFileWriter.write(Path file, OwnedPaths owned, String expectedFingerprint, Consumer<ConfigDocument> edit, AtomicConfigWriter.FileOperations files) AsOperatorFileWriter.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 OwnedPathsModifierConstructorDescriptionprivateStaged(Path file, Path absolute, OwnedPaths owned, List<String> keys, String rendered, ConfigDocument candidate, String read, String readText, AtomicConfigWriter.StagedWrite temporary) -
Uses of OwnedPaths in com.ultikits.ultitools.utils
Methods in com.ultikits.ultitools.utils that return OwnedPathsModifier and TypeMethodDescriptionprivate static OwnedPathsRemoteConfigHandler.owned(List<RemoteConfigHandler.Accepted> accepted)