io.permazen.util

Class Diffs

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,Diffs>

io.permazen.util.Diffs

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Diffs>

public class Diffs
extends LinkedHashMap<String,Diffs>

Used to report difference(s) between two hierarchical structures.

Each individual difference is a String (map key) and has optional further detail contained in another Diffs instance (map value, or null for none). Keys must not be null.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
Diffs() Default constructor.
Diffs(Diffs other) Copy constructor.

Method Summary

Modifier and Type	Method and Description
void	add(String description) Add a difference without any sub-differences.
void	add(String description, Diffs diffs) Add a difference with optional sub-differences.
String	toString() Format this instance as a String.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Constructor Detail

Diffs

public Diffs()

Default constructor.

Diffs

public Diffs(Diffs other)

Copy constructor. Performs a shallow copy.

Parameters:

other - instance to copy

Method Detail

add

public void add(String description)

Add a difference without any sub-differences.

Parameters:

description - description of the difference

Throws:

IllegalArgumentException - if description is null

add

public void add(String description,
                Diffs diffs)

Add a difference with optional sub-differences.

Parameters:

description - description of the difference

diffs - sub-differences, or null for none

Throws:

IllegalArgumentException - if description is null

toString

public String toString()

Format this instance as a String.

Overrides:

toString in class AbstractMap<String,Diffs>