Record Class JavaPackage

java.lang.Object

java.lang.Record

dev.archunitjava.model.JavaPackage

All Implemented Interfaces:

Comparable<JavaPackage>

public record JavaPackage(JavaPackageName name, List<JavaType> types, List<JavaType> packageInfoTypes, List<JavaAnnotationOccurrence> annotations, List<JavaPackageOrigin> origins)
extends Record
implements Comparable<JavaPackage>

Aggregated Java package with metadata carriers separated from ordinary types.

Constructor Summary

Constructors

Constructor	Description
JavaPackage(JavaPackageName name, List<JavaType> types, List<JavaType> packageInfoTypes, List<JavaAnnotationOccurrence> annotations, List<JavaPackageOrigin> origins)	Creates an instance of a JavaPackage record class.

Method Summary

Modifier and Type	Method	Description
List<JavaAnnotationOccurrence>	annotations()	Returns the value of the annotations record component.
int	compareTo(JavaPackage 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.
boolean	isSplitAcrossOrigins()
JavaPackageName	name()	Returns the value of the name record component.
List<JavaPackageOrigin>	origins()	Returns the value of the origins record component.
Optional<JavaType>	packageInfoType()
List<JavaType>	packageInfoTypes()	Returns the value of the packageInfoTypes record component.
final String	toString()	Returns a string representation of this record class.
List<JavaType>	types()	Returns the value of the types record component.

Methods inherited from class Object

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

Constructor Details

JavaPackage

public JavaPackage(JavaPackageName name,
 List<JavaType> types,
 List<JavaType> packageInfoTypes,
 List<JavaAnnotationOccurrence> annotations,
 List<JavaPackageOrigin> origins)

Creates an instance of a JavaPackage record class.

Parameters:

name - the value for the name record component

types - the value for the types record component

packageInfoTypes - the value for the packageInfoTypes record component

annotations - the value for the annotations record component

origins - the value for the origins record component

Method Details

isSplitAcrossOrigins

public boolean isSplitAcrossOrigins()

packageInfoType

public Optional<JavaType> packageInfoType()

compareTo

public int compareTo(JavaPackage other)

Specified by:

compareTo in interface Comparable<JavaPackage>

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.

name

public JavaPackageName name()

Returns the value of the name record component.

Returns:

the value of the name record component

types

public List<JavaType> types()

Returns the value of the types record component.

Returns:

the value of the types record component

packageInfoTypes

public List<JavaType> packageInfoTypes()

Returns the value of the packageInfoTypes record component.

Returns:

the value of the packageInfoTypes record component

annotations

public List<JavaAnnotationOccurrence> annotations()

Returns the value of the annotations record component.

Returns:

the value of the annotations record component

origins

public List<JavaPackageOrigin> origins()

Returns the value of the origins record component.

Returns:

the value of the origins record component