Record Class JavaModuleIdentity

java.lang.Object

java.lang.Record

dev.archunitjava.model.JavaModuleIdentity

All Implemented Interfaces:

Comparable<JavaModuleIdentity>

public record JavaModuleIdentity(JavaModuleKind kind, Optional<String> name, Optional<String> unnamedOrigin)
extends Record
implements Comparable<JavaModuleIdentity>

JPMS identity that never conflates explicit, automatic, and unnamed modules.

Constructor Summary

Constructors

Constructor	Description
JavaModuleIdentity(JavaModuleKind kind, Optional<String> name, Optional<String> unnamedOrigin)	Creates an instance of a JavaModuleIdentity record class.

Method Summary

Modifier and Type	Method	Description
static JavaModuleIdentity	automatic(String name)
int	compareTo(JavaModuleIdentity other)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static JavaModuleIdentity	explicit(String name)
final int	hashCode()	Returns a hash code value for this object.
JavaModuleKind	kind()	Returns the value of the kind record component.
Optional<String>	name()	Returns the value of the name record component.
String	stableKey()
final String	toString()	Returns a string representation of this record class.
static JavaModuleIdentity	unnamed(String originIdentity)
Optional<String>	unnamedOrigin()	Returns the value of the unnamedOrigin record component.

Methods inherited from class Object

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

Constructor Details

JavaModuleIdentity

public JavaModuleIdentity(JavaModuleKind kind,
 Optional<String> name,
 Optional<String> unnamedOrigin)

Creates an instance of a JavaModuleIdentity record class.

Parameters:

kind - the value for the kind record component

name - the value for the name record component

unnamedOrigin - the value for the unnamedOrigin record component

Method Details

explicit

public static JavaModuleIdentity explicit(String name)

automatic

public static JavaModuleIdentity automatic(String name)

unnamed

public static JavaModuleIdentity unnamed(String originIdentity)

stableKey

public String stableKey()

compareTo

public int compareTo(JavaModuleIdentity other)

Specified by:

compareTo in interface Comparable<JavaModuleIdentity>

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.

kind

public JavaModuleKind kind()

Returns the value of the kind record component.

Returns:

the value of the kind record component

name

public Optional<String> name()

Returns the value of the name record component.

Returns:

the value of the name record component

unnamedOrigin

public Optional<String> unnamedOrigin()

Returns the value of the unnamedOrigin record component.

Returns:

the value of the unnamedOrigin record component