Module com.github.sormuras.bach

Package com.github.sormuras.bach.project

Record Class DeclaredModule

java.lang.Object

java.lang.Record

com.github.sormuras.bach.project.DeclaredModule

All Implemented Interfaces:

Comparable<DeclaredModule>

public record DeclaredModule(ModuleDescriptor descriptor, Path info, Optional<String> mainClass, Folders folders)
extends Record
implements Comparable<DeclaredModule>

A module declaration with its possibly targeted folders.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeclaredModule.Operator
static final record	DeclaredModule.Tweak

Constructor Summary

Constructors

Constructor	Description
DeclaredModule(ModuleDescriptor descriptor, Path info, Optional<String> mainClass, Folders folders)	Creates an instance of a DeclaredModule record class.

Method Summary

Modifier and Type	Method	Description
int	compareTo(DeclaredModule other)
ModuleDescriptor	descriptor()	Returns the value of the descriptor record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Folders	folders()	Returns the value of the folders record component.
final int	hashCode()	Returns a hash code value for this object.
Path	info()	Returns the value of the info record component.
Optional<String>	mainClass()	Returns the value of the mainClass record component.
String	name()
static DeclaredModule	of(Path pathOfModuleInfoJavaOrItsParentDirectory)
static DeclaredModule	of(Path pathOfModuleInfoJavaOrItsParentDirectory, int version, FolderType... types)
final String	toString()	Returns a string representation of this record class.
DeclaredModule	withFolder(Path directory, int release, FolderType... types)
DeclaredModule	withMainClass(String name)
DeclaredModule	withResourcesFolder(String directory)
DeclaredModule	withResourcesFolder(String directory, int release)
DeclaredModule	withSourcesFolder(String directory)
DeclaredModule	withSourcesFolder(String directory, int release)

Methods inherited from class java.lang.Object

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

Constructor Details

DeclaredModule

public DeclaredModule(ModuleDescriptor descriptor,
 Path info,
 Optional<String> mainClass,
 Folders folders)

Creates an instance of a DeclaredModule record class.

Parameters:

descriptor - the value for the descriptor record component

info - the value for the info record component

mainClass - the value for the mainClass record component

folders - the value for the folders record component

Method Details

name

public String name()

of

public static DeclaredModule of(Path pathOfModuleInfoJavaOrItsParentDirectory)

of

public static DeclaredModule of(Path pathOfModuleInfoJavaOrItsParentDirectory,
 int version,
 FolderType... types)

compareTo

public int compareTo(DeclaredModule other)

Specified by:

compareTo in interface Comparable<DeclaredModule>

withMainClass

public DeclaredModule withMainClass(String name)

withSourcesFolder

public DeclaredModule withSourcesFolder(String directory)

withSourcesFolder

public DeclaredModule withSourcesFolder(String directory,
 int release)

withResourcesFolder

public DeclaredModule withResourcesFolder(String directory)

withResourcesFolder

public DeclaredModule withResourcesFolder(String directory,
 int release)

withFolder

public DeclaredModule withFolder(Path directory,
 int release,
 FolderType... types)

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.

descriptor

public ModuleDescriptor descriptor()

Returns the value of the descriptor record component.

Returns:

the value of the descriptor record component

info

public Path info()

Returns the value of the info record component.

Returns:

the value of the info record component

mainClass

public Optional<String> mainClass()

Returns the value of the mainClass record component.

Returns:

the value of the mainClass record component

folders

public Folders folders()

Returns the value of the folders record component.

Returns:

the value of the folders record component