Record Class CycleAnalysisResult

java.lang.Object

java.lang.Record

dev.archunitjava.projection.CycleAnalysisResult

public record CycleAnalysisResult(List<StronglyConnectedComponent> components, List<ElementaryCycle> cycles, boolean enumerationPerformed, boolean enumerationTruncated, long traversedEdges)
extends Record

Pure cycle-analysis output, including whether diagnostic enumeration hit a bound.

Constructor Summary

Constructors

Constructor	Description
CycleAnalysisResult(List<StronglyConnectedComponent> components, List<ElementaryCycle> cycles, boolean enumerationPerformed, boolean enumerationTruncated, long traversedEdges)	Creates an instance of a CycleAnalysisResult record class.

Method Summary

Modifier and Type	Method	Description
List<StronglyConnectedComponent>	components()	Returns the value of the components record component.
List<ElementaryCycle>	cycles()	Returns the value of the cycles record component.
List<StronglyConnectedComponent>	cyclicComponents()
boolean	enumerationPerformed()	Returns the value of the enumerationPerformed record component.
boolean	enumerationTruncated()	Returns the value of the enumerationTruncated 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.
final String	toString()	Returns a string representation of this record class.
long	traversedEdges()	Returns the value of the traversedEdges record component.

Methods inherited from class Object

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

Constructor Details

CycleAnalysisResult

public CycleAnalysisResult(List<StronglyConnectedComponent> components,
 List<ElementaryCycle> cycles,
 boolean enumerationPerformed,
 boolean enumerationTruncated,
 long traversedEdges)

Creates an instance of a CycleAnalysisResult record class.

Parameters:

components - the value for the components record component

cycles - the value for the cycles record component

enumerationPerformed - the value for the enumerationPerformed record component

enumerationTruncated - the value for the enumerationTruncated record component

traversedEdges - the value for the traversedEdges record component

Method Details

cyclicComponents

public List<StronglyConnectedComponent> cyclicComponents()

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.

components

public List<StronglyConnectedComponent> components()

Returns the value of the components record component.

Returns:

the value of the components record component

cycles

public List<ElementaryCycle> cycles()

Returns the value of the cycles record component.

Returns:

the value of the cycles record component

enumerationPerformed

public boolean enumerationPerformed()

Returns the value of the enumerationPerformed record component.

Returns:

the value of the enumerationPerformed record component

enumerationTruncated

public boolean enumerationTruncated()

Returns the value of the enumerationTruncated record component.

Returns:

the value of the enumerationTruncated record component

traversedEdges

public long traversedEdges()

Returns the value of the traversedEdges record component.

Returns:

the value of the traversedEdges record component