Record Class GraphSnapshot

java.lang.Object

java.lang.Record

dev.archunitjava.report.GraphSnapshot

public record GraphSnapshot(String schemaVersion, SnapshotQueryMetadata query, List<SnapshotNode> nodes, List<SnapshotEdge> edges)
extends Record

Versioned immutable graph snapshot consumed verbatim by all report renderers.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SCHEMA_VERSION

Constructor Summary

Constructors

Constructor	Description
GraphSnapshot(SnapshotQueryMetadata query, List<SnapshotNode> nodes, List<SnapshotEdge> edges)
GraphSnapshot(String schemaVersion, SnapshotQueryMetadata query, List<SnapshotNode> nodes, List<SnapshotEdge> edges)	Creates an instance of a GraphSnapshot record class.

Method Summary

Modifier and Type	Method	Description
List<SnapshotEdge>	edges()	Returns the value of the edges record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
List<SnapshotNode>	nodes()	Returns the value of the nodes record component.
SnapshotQueryMetadata	query()	Returns the value of the query record component.
String	schemaVersion()	Returns the value of the schemaVersion record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

SCHEMA_VERSION

public static final String SCHEMA_VERSION

See Also:

• Constant Field Values

Constructor Details

GraphSnapshot

public GraphSnapshot(String schemaVersion,
 SnapshotQueryMetadata query,
 List<SnapshotNode> nodes,
 List<SnapshotEdge> edges)

Creates an instance of a GraphSnapshot record class.

Parameters:

schemaVersion - the value for the schemaVersion record component

query - the value for the query record component

nodes - the value for the nodes record component

edges - the value for the edges record component

GraphSnapshot

public GraphSnapshot(SnapshotQueryMetadata query,
 List<SnapshotNode> nodes,
 List<SnapshotEdge> edges)

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

schemaVersion

public String schemaVersion()

Returns the value of the schemaVersion record component.

Returns:

the value of the schemaVersion record component

query

public SnapshotQueryMetadata query()

Returns the value of the query record component.

Returns:

the value of the query record component

nodes

public List<SnapshotNode> nodes()

Returns the value of the nodes record component.

Returns:

the value of the nodes record component

edges

public List<SnapshotEdge> edges()

Returns the value of the edges record component.

Returns:

the value of the edges record component