Record Class SnapshotQueryMetadata

java.lang.Object

java.lang.Record

dev.archunitjava.report.SnapshotQueryMetadata

public record SnapshotQueryMetadata(ReportDomain domain, List<String> includedKinds, List<String> includedNodeIds, List<String> excludedNodeIds, boolean retainSelfEdges, int mappingCount, int sourceNodeCount, int sourceEdgeCount, int mappedSourceNodeCount, int matchedNodeCount, int matchedEdgeCount, int omittedNodeCount, int omittedEdgeCount, int omittedEvidenceCount, GraphSnapshotLimits limits)
extends Record

Complete deterministic query and truncation metadata shared by every renderer.

Constructor Summary

Constructors

Constructor	Description
SnapshotQueryMetadata(ReportDomain domain, List<String> includedKinds, List<String> includedNodeIds, List<String> excludedNodeIds, boolean retainSelfEdges, int mappingCount, int sourceNodeCount, int sourceEdgeCount, int mappedSourceNodeCount, int matchedNodeCount, int matchedEdgeCount, int omittedNodeCount, int omittedEdgeCount, int omittedEvidenceCount, GraphSnapshotLimits limits)	Creates an instance of a SnapshotQueryMetadata record class.

Method Summary

Modifier and Type	Method	Description
ReportDomain	domain()	Returns the value of the domain record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<String>	excludedNodeIds()	Returns the value of the excludedNodeIds record component.
final int	hashCode()	Returns a hash code value for this object.
List<String>	includedKinds()	Returns the value of the includedKinds record component.
List<String>	includedNodeIds()	Returns the value of the includedNodeIds record component.
GraphSnapshotLimits	limits()	Returns the value of the limits record component.
int	mappedSourceNodeCount()	Returns the value of the mappedSourceNodeCount record component.
int	mappingCount()	Returns the value of the mappingCount record component.
int	matchedEdgeCount()	Returns the value of the matchedEdgeCount record component.
int	matchedNodeCount()	Returns the value of the matchedNodeCount record component.
int	omittedEdgeCount()	Returns the value of the omittedEdgeCount record component.
int	omittedEvidenceCount()	Returns the value of the omittedEvidenceCount record component.
int	omittedNodeCount()	Returns the value of the omittedNodeCount record component.
boolean	retainSelfEdges()	Returns the value of the retainSelfEdges record component.
int	sourceEdgeCount()	Returns the value of the sourceEdgeCount record component.
int	sourceNodeCount()	Returns the value of the sourceNodeCount record component.
final String	toString()	Returns a string representation of this record class.
boolean	truncated()

Methods inherited from class Object

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

Constructor Details

SnapshotQueryMetadata

public SnapshotQueryMetadata(ReportDomain domain,
 List<String> includedKinds,
 List<String> includedNodeIds,
 List<String> excludedNodeIds,
 boolean retainSelfEdges,
 int mappingCount,
 int sourceNodeCount,
 int sourceEdgeCount,
 int mappedSourceNodeCount,
 int matchedNodeCount,
 int matchedEdgeCount,
 int omittedNodeCount,
 int omittedEdgeCount,
 int omittedEvidenceCount,
 GraphSnapshotLimits limits)

Creates an instance of a SnapshotQueryMetadata record class.

Parameters:

domain - the value for the domain record component

includedKinds - the value for the includedKinds record component

includedNodeIds - the value for the includedNodeIds record component

excludedNodeIds - the value for the excludedNodeIds record component

retainSelfEdges - the value for the retainSelfEdges record component

mappingCount - the value for the mappingCount record component

sourceNodeCount - the value for the sourceNodeCount record component

sourceEdgeCount - the value for the sourceEdgeCount record component

mappedSourceNodeCount - the value for the mappedSourceNodeCount record component

matchedNodeCount - the value for the matchedNodeCount record component

matchedEdgeCount - the value for the matchedEdgeCount record component

omittedNodeCount - the value for the omittedNodeCount record component

omittedEdgeCount - the value for the omittedEdgeCount record component

omittedEvidenceCount - the value for the omittedEvidenceCount record component

limits - the value for the limits record component

Method Details

truncated

public boolean truncated()

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

domain

public ReportDomain domain()

Returns the value of the domain record component.

Returns:

the value of the domain record component

includedKinds

public List<String> includedKinds()

Returns the value of the includedKinds record component.

Returns:

the value of the includedKinds record component

includedNodeIds

public List<String> includedNodeIds()

Returns the value of the includedNodeIds record component.

Returns:

the value of the includedNodeIds record component

excludedNodeIds

public List<String> excludedNodeIds()

Returns the value of the excludedNodeIds record component.

Returns:

the value of the excludedNodeIds record component

retainSelfEdges

public boolean retainSelfEdges()

Returns the value of the retainSelfEdges record component.

Returns:

the value of the retainSelfEdges record component

mappingCount

public int mappingCount()

Returns the value of the mappingCount record component.

Returns:

the value of the mappingCount record component

sourceNodeCount

public int sourceNodeCount()

Returns the value of the sourceNodeCount record component.

Returns:

the value of the sourceNodeCount record component

sourceEdgeCount

public int sourceEdgeCount()

Returns the value of the sourceEdgeCount record component.

Returns:

the value of the sourceEdgeCount record component

mappedSourceNodeCount

public int mappedSourceNodeCount()

Returns the value of the mappedSourceNodeCount record component.

Returns:

the value of the mappedSourceNodeCount record component

matchedNodeCount

public int matchedNodeCount()

Returns the value of the matchedNodeCount record component.

Returns:

the value of the matchedNodeCount record component

matchedEdgeCount

public int matchedEdgeCount()

Returns the value of the matchedEdgeCount record component.

Returns:

the value of the matchedEdgeCount record component

omittedNodeCount

public int omittedNodeCount()

Returns the value of the omittedNodeCount record component.

Returns:

the value of the omittedNodeCount record component

omittedEdgeCount

public int omittedEdgeCount()

Returns the value of the omittedEdgeCount record component.

Returns:

the value of the omittedEdgeCount record component

omittedEvidenceCount

public int omittedEvidenceCount()

Returns the value of the omittedEvidenceCount record component.

Returns:

the value of the omittedEvidenceCount record component

limits

public GraphSnapshotLimits limits()

Returns the value of the limits record component.

Returns:

the value of the limits record component