Record Class ImportResourceRule

java.lang.Object

java.lang.Record

dev.archunitjava.importer.ImportResourceRule

public record ImportResourceRule(ImportRuleAction action, JavaPattern pattern, String source, int line)
extends Record

One immutable, reviewable include/exclude rule for a root-relative resource path.

Constructor Summary

Constructors

Constructor	Description
ImportResourceRule(ImportRuleAction action, JavaPattern pattern, String source, int line)	Creates an instance of a ImportResourceRule record class.

Method Summary

Modifier and Type	Method	Description
ImportRuleAction	action()	Returns the value of the action record component.
String	description()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static ImportResourceRule	exclude(String glob)
final int	hashCode()	Returns a hash code value for this object.
static ImportResourceRule	include(String glob)
int	line()	Returns the value of the line record component.
boolean	matches(String rootRelativeResource)
JavaPattern	pattern()	Returns the value of the pattern record component.
String	source()	Returns the value of the source 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

ImportResourceRule

public ImportResourceRule(ImportRuleAction action,
 JavaPattern pattern,
 String source,
 int line)

Creates an instance of a ImportResourceRule record class.

Parameters:

action - the value for the action record component

pattern - the value for the pattern record component

source - the value for the source record component

line - the value for the line record component

Method Details

include

public static ImportResourceRule include(String glob)

exclude

public static ImportResourceRule exclude(String glob)

matches

public boolean matches(String rootRelativeResource)

description

public String description()

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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

action

public ImportRuleAction action()

Returns the value of the action record component.

Returns:

the value of the action record component

pattern

public JavaPattern pattern()

Returns the value of the pattern record component.

Returns:

the value of the pattern record component

source

public String source()

Returns the value of the source record component.

Returns:

the value of the source record component

line

public int line()

Returns the value of the line record component.

Returns:

the value of the line record component