Record Class JavaModule

java.lang.Object

java.lang.Record

dev.archunitjava.model.JavaModule

All Implemented Interfaces:

Comparable<JavaModule>

public record JavaModule(JavaModuleIdentity identity, int flags, Optional<String> version, List<JavaModuleRequire> requires, List<JavaModulePackageDirective> exports, List<JavaModulePackageDirective> opens, List<JvmReferenceType> uses, List<JavaModuleProvide> provides, DeclarationLocation location)
extends Record
implements Comparable<JavaModule>

Immutable module identity and its explicit, unresolved JPMS directives.

Constructor Summary

Constructors

Constructor	Description
JavaModule(JavaModuleIdentity identity, int flags, Optional<String> version, List<JavaModuleRequire> requires, List<JavaModulePackageDirective> exports, List<JavaModulePackageDirective> opens, List<JvmReferenceType> uses, List<JavaModuleProvide> provides, DeclarationLocation location)	Creates an instance of a JavaModule record class.

Method Summary

Modifier and Type	Method	Description
int	compareTo(JavaModule other)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<JavaModulePackageDirective>	exports()	Returns the value of the exports record component.
int	flags()	Returns the value of the flags record component.
final int	hashCode()	Returns a hash code value for this object.
JavaModuleIdentity	identity()	Returns the value of the identity record component.
DeclarationLocation	location()	Returns the value of the location record component.
boolean	open()
List<JavaModulePackageDirective>	opens()	Returns the value of the opens record component.
List<JavaModuleProvide>	provides()	Returns the value of the provides record component.
List<JavaModuleRequire>	requires()	Returns the value of the requires record component.
final String	toString()	Returns a string representation of this record class.
List<JvmReferenceType>	uses()	Returns the value of the uses record component.
Optional<String>	version()	Returns the value of the version record component.

Methods inherited from class Object

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

Constructor Details

JavaModule

public JavaModule(JavaModuleIdentity identity,
 int flags,
 Optional<String> version,
 List<JavaModuleRequire> requires,
 List<JavaModulePackageDirective> exports,
 List<JavaModulePackageDirective> opens,
 List<JvmReferenceType> uses,
 List<JavaModuleProvide> provides,
 DeclarationLocation location)

Creates an instance of a JavaModule record class.

Parameters:

identity - the value for the identity record component

flags - the value for the flags record component

version - the value for the version record component

requires - the value for the requires record component

exports - the value for the exports record component

opens - the value for the opens record component

uses - the value for the uses record component

provides - the value for the provides record component

location - the value for the location record component

Method Details

open

public boolean open()

compareTo

public int compareTo(JavaModule other)

Specified by:

compareTo in interface Comparable<JavaModule>

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.

identity

public JavaModuleIdentity identity()

Returns the value of the identity record component.

Returns:

the value of the identity record component

flags

public int flags()

Returns the value of the flags record component.

Returns:

the value of the flags record component

version

public Optional<String> version()

Returns the value of the version record component.

Returns:

the value of the version record component

requires

public List<JavaModuleRequire> requires()

Returns the value of the requires record component.

Returns:

the value of the requires record component

exports

public List<JavaModulePackageDirective> exports()

Returns the value of the exports record component.

Returns:

the value of the exports record component

opens

public List<JavaModulePackageDirective> opens()

Returns the value of the opens record component.

Returns:

the value of the opens record component

uses

public List<JvmReferenceType> uses()

Returns the value of the uses record component.

Returns:

the value of the uses record component

provides

public List<JavaModuleProvide> provides()

Returns the value of the provides record component.

Returns:

the value of the provides record component

location

public DeclarationLocation location()

Returns the value of the location record component.

Returns:

the value of the location record component