Record Class ElementaryCycle

java.lang.Object

java.lang.Record

dev.archunitjava.projection.ElementaryCycle

All Implemented Interfaces:

Comparable<ElementaryCycle>

public record ElementaryCycle(List<StableId> nodes)
extends Record
implements Comparable<ElementaryCycle>

A directed elementary cycle, stored once with its lowest stable node first.

Constructor Summary

Constructors

Constructor	Description
ElementaryCycle(List<StableId> nodes)	Creates an instance of a ElementaryCycle record class.

Method Summary

Modifier and Type	Method	Description
List<StableId>	closedPath()	The diagnostic path including the closing occurrence of the first node.
int	compareTo(ElementaryCycle other)
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<StableId>	nodes()	Returns the value of the nodes 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

Constructor Details

ElementaryCycle

public ElementaryCycle(List<StableId> nodes)

Creates an instance of a ElementaryCycle record class.

Parameters:

nodes - the value for the nodes record component

Method Details

closedPath

public List<StableId> closedPath()

The diagnostic path including the closing occurrence of the first node.

compareTo

public int compareTo(ElementaryCycle other)

Specified by:

compareTo in interface Comparable<ElementaryCycle>

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.

nodes

public List<StableId> nodes()

Returns the value of the nodes record component.

Returns:

the value of the nodes record component