Record Class DependencyRuleSpec

java.lang.Object

java.lang.Record

dev.archunitjava.rules.DependencyRuleSpec

public record DependencyRuleSpec(DependencyRuleMode mode, SelfDependencyPolicy selfDependencies, ExternalDependencyPolicy externalDependencies)
extends Record

Immutable dependency mood and edge-boundary policies.

Constructor Summary

Constructors

Constructor	Description
DependencyRuleSpec(DependencyRuleMode mode, SelfDependencyPolicy selfDependencies, ExternalDependencyPolicy externalDependencies)	Creates an instance of a DependencyRuleSpec record class.

Method Summary

Modifier and Type	Method	Description
static DependencyRuleSpec	anyDependency()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ExternalDependencyPolicy	externalDependencies()	Returns the value of the externalDependencies record component.
final int	hashCode()	Returns a hash code value for this object.
DependencyRuleMode	mode()	Returns the value of the mode record component.
static DependencyRuleSpec	noDependencies()
static DependencyRuleSpec	onlyDependencies()
static DependencyRuleSpec	requiredDependency()
SelfDependencyPolicy	selfDependencies()	Returns the value of the selfDependencies record component.
final String	toString()	Returns a string representation of this record class.
DependencyRuleSpec	withExternalDependencies(ExternalDependencyPolicy value)
DependencyRuleSpec	withSelfDependencies(SelfDependencyPolicy value)

Methods inherited from class Object

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

Constructor Details

DependencyRuleSpec

public DependencyRuleSpec(DependencyRuleMode mode,
 SelfDependencyPolicy selfDependencies,
 ExternalDependencyPolicy externalDependencies)

Creates an instance of a DependencyRuleSpec record class.

Parameters:

mode - the value for the mode record component

selfDependencies - the value for the selfDependencies record component

externalDependencies - the value for the externalDependencies record component

Method Details

noDependencies

public static DependencyRuleSpec noDependencies()

onlyDependencies

public static DependencyRuleSpec onlyDependencies()

anyDependency

public static DependencyRuleSpec anyDependency()

requiredDependency

public static DependencyRuleSpec requiredDependency()

withSelfDependencies

public DependencyRuleSpec withSelfDependencies(SelfDependencyPolicy value)

withExternalDependencies

public DependencyRuleSpec withExternalDependencies(ExternalDependencyPolicy value)

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.

mode

public DependencyRuleMode mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component

selfDependencies

public SelfDependencyPolicy selfDependencies()

Returns the value of the selfDependencies record component.

Returns:

the value of the selfDependencies record component

externalDependencies

public ExternalDependencyPolicy externalDependencies()

Returns the value of the externalDependencies record component.

Returns:

the value of the externalDependencies record component