Record Class HierarchyRuleSpec

java.lang.Object

java.lang.Record

dev.archunitjava.rules.HierarchyRuleSpec

public record HierarchyRuleSpec(HierarchyRelation relation, HierarchyDepth depth, HierarchyRuleMode mode, UnknownInheritancePolicy unknownHierarchy)
extends Record

Immutable relationship, traversal, mood, and unknown-ancestor policy.

Constructor Summary

Constructors

Constructor	Description
HierarchyRuleSpec(HierarchyRelation relation, HierarchyDepth depth, HierarchyRuleMode mode, UnknownInheritancePolicy unknownHierarchy)	Creates an instance of a HierarchyRuleSpec record class.

Method Summary

Modifier and Type	Method	Description
HierarchyDepth	depth()	Returns the value of the depth record component.
static HierarchyRuleSpec	direct(HierarchyRelation relation, HierarchyRuleMode mode)
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.
HierarchyRuleMode	mode()	Returns the value of the mode record component.
static HierarchyRuleSpec	permitting(HierarchyRuleMode mode)
HierarchyRelation	relation()	Returns the value of the relation record component.
final String	toString()	Returns a string representation of this record class.
static HierarchyRuleSpec	transitive(HierarchyRelation relation, HierarchyRuleMode mode)
UnknownInheritancePolicy	unknownHierarchy()	Returns the value of the unknownHierarchy record component.
HierarchyRuleSpec	withUnknownHierarchy(UnknownInheritancePolicy value)

Methods inherited from class Object

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

Constructor Details

HierarchyRuleSpec

public HierarchyRuleSpec(HierarchyRelation relation,
 HierarchyDepth depth,
 HierarchyRuleMode mode,
 UnknownInheritancePolicy unknownHierarchy)

Creates an instance of a HierarchyRuleSpec record class.

Parameters:

relation - the value for the relation record component

depth - the value for the depth record component

mode - the value for the mode record component

unknownHierarchy - the value for the unknownHierarchy record component

Method Details

direct

public static HierarchyRuleSpec direct(HierarchyRelation relation,
 HierarchyRuleMode mode)

transitive

public static HierarchyRuleSpec transitive(HierarchyRelation relation,
 HierarchyRuleMode mode)

permitting

public static HierarchyRuleSpec permitting(HierarchyRuleMode mode)

withUnknownHierarchy

public HierarchyRuleSpec withUnknownHierarchy(UnknownInheritancePolicy 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.

relation

public HierarchyRelation relation()

Returns the value of the relation record component.

Returns:

the value of the relation record component

depth

public HierarchyDepth depth()

Returns the value of the depth record component.

Returns:

the value of the depth record component

mode

public HierarchyRuleMode mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component

unknownHierarchy

public UnknownInheritancePolicy unknownHierarchy()

Returns the value of the unknownHierarchy record component.

Returns:

the value of the unknownHierarchy record component