Record Class HierarchyRelationship

java.lang.Object

java.lang.Record

dev.archunitjava.model.HierarchyRelationship

All Implemented Interfaces:

Comparable<HierarchyRelationship>

public record HierarchyRelationship(JavaTypeName origin, JavaTypeName target, HierarchyRelationshipKind kind)
extends Record
implements Comparable<HierarchyRelationship>

One direct, typed hierarchy relationship.

Constructor Summary

Constructors

Constructor	Description
HierarchyRelationship(JavaTypeName origin, JavaTypeName target, HierarchyRelationshipKind kind)	Creates an instance of a HierarchyRelationship record class.

Method Summary

Modifier and Type	Method	Description
int	compareTo(HierarchyRelationship 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.
HierarchyRelationshipKind	kind()	Returns the value of the kind record component.
JavaTypeName	origin()	Returns the value of the origin record component.
JavaTypeName	target()	Returns the value of the target 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

HierarchyRelationship

public HierarchyRelationship(JavaTypeName origin,
 JavaTypeName target,
 HierarchyRelationshipKind kind)

Creates an instance of a HierarchyRelationship record class.

Parameters:

origin - the value for the origin record component

target - the value for the target record component

kind - the value for the kind record component

Method Details

compareTo

public int compareTo(HierarchyRelationship other)

Specified by:

compareTo in interface Comparable<HierarchyRelationship>

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.

origin

public JavaTypeName origin()

Returns the value of the origin record component.

Returns:

the value of the origin record component

target

public JavaTypeName target()

Returns the value of the target record component.

Returns:

the value of the target record component

kind

public HierarchyRelationshipKind kind()

Returns the value of the kind record component.

Returns:

the value of the kind record component