Record Class CycleEnumerationOptions

java.lang.Object

java.lang.Record

dev.archunitjava.projection.CycleEnumerationOptions

public record CycleEnumerationOptions(boolean enabled, int maximumCycles, int maximumCycleLength, long maximumTraversedEdges)
extends Record

Explicit resource bounds for optional elementary-cycle diagnostics.

Constructor Summary

Constructors

Constructor	Description
CycleEnumerationOptions(boolean enabled, int maximumCycles, int maximumCycleLength, long maximumTraversedEdges)	Creates an instance of a CycleEnumerationOptions record class.

Method Summary

Modifier and Type	Method	Description
static CycleEnumerationOptions	bounded(int maximumCycles, int maximumCycleLength, long maximumTraversedEdges)
static CycleEnumerationOptions	componentsOnly()
static CycleEnumerationOptions	defaults()	Conservative defaults suitable for interactive diagnostics.
boolean	enabled()	Returns the value of the enabled 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.
int	maximumCycleLength()	Returns the value of the maximumCycleLength record component.
int	maximumCycles()	Returns the value of the maximumCycles record component.
long	maximumTraversedEdges()	Returns the value of the maximumTraversedEdges 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

CycleEnumerationOptions

public CycleEnumerationOptions(boolean enabled,
 int maximumCycles,
 int maximumCycleLength,
 long maximumTraversedEdges)

Creates an instance of a CycleEnumerationOptions record class.

Parameters:

enabled - the value for the enabled record component

maximumCycles - the value for the maximumCycles record component

maximumCycleLength - the value for the maximumCycleLength record component

maximumTraversedEdges - the value for the maximumTraversedEdges record component

Method Details

defaults

public static CycleEnumerationOptions defaults()

Conservative defaults suitable for interactive diagnostics.

bounded

public static CycleEnumerationOptions bounded(int maximumCycles,
 int maximumCycleLength,
 long maximumTraversedEdges)

componentsOnly

public static CycleEnumerationOptions componentsOnly()

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 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.

enabled

public boolean enabled()

Returns the value of the enabled record component.

Returns:

the value of the enabled record component

maximumCycles

public int maximumCycles()

Returns the value of the maximumCycles record component.

Returns:

the value of the maximumCycles record component

maximumCycleLength

public int maximumCycleLength()

Returns the value of the maximumCycleLength record component.

Returns:

the value of the maximumCycleLength record component

maximumTraversedEdges

public long maximumTraversedEdges()

Returns the value of the maximumTraversedEdges record component.

Returns:

the value of the maximumTraversedEdges record component