Record Class ModulePackageRuleSpec

java.lang.Object

java.lang.Record

dev.archunitjava.rules.ModulePackageRuleSpec

public record ModulePackageRuleSpec(ModuleRuleMode mode, DirectiveQualification qualification, Optional<JavaPattern> targetModule)
extends Record

Exports/opens mode with qualification and optional qualified target matching.

Constructor Summary

Constructors

Constructor	Description
ModulePackageRuleSpec(ModuleRuleMode mode, DirectiveQualification qualification, Optional<JavaPattern> targetModule)	Creates an instance of a ModulePackageRuleSpec record class.

Method Summary

Modifier and Type	Method	Description
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.
ModuleRuleMode	mode()	Returns the value of the mode record component.
static ModulePackageRuleSpec	no()
static ModulePackageRuleSpec	only()
DirectiveQualification	qualification()	Returns the value of the qualification record component.
static ModulePackageRuleSpec	required()
ModulePackageRuleSpec	targetedTo(JavaPattern value)
Optional<JavaPattern>	targetModule()	Returns the value of the targetModule record component.
final String	toString()	Returns a string representation of this record class.
ModulePackageRuleSpec	withQualification(DirectiveQualification value)

Methods inherited from class Object

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

Constructor Details

ModulePackageRuleSpec

public ModulePackageRuleSpec(ModuleRuleMode mode,
 DirectiveQualification qualification,
 Optional<JavaPattern> targetModule)

Creates an instance of a ModulePackageRuleSpec record class.

Parameters:

mode - the value for the mode record component

qualification - the value for the qualification record component

targetModule - the value for the targetModule record component

Method Details

no

public static ModulePackageRuleSpec no()

only

public static ModulePackageRuleSpec only()

required

public static ModulePackageRuleSpec required()

withQualification

public ModulePackageRuleSpec withQualification(DirectiveQualification value)

targetedTo

public ModulePackageRuleSpec targetedTo(JavaPattern 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 ModuleRuleMode mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component

qualification

public DirectiveQualification qualification()

Returns the value of the qualification record component.

Returns:

the value of the qualification record component

targetModule

public Optional<JavaPattern> targetModule()

Returns the value of the targetModule record component.

Returns:

the value of the targetModule record component