Record Class ModuleConfiguration

java.lang.Object

java.lang.Record

eu.cloudnetservice.driver.module.ModuleConfiguration

Record Components:

runtimeModule - whether this module is a runtime module. Runtime modules are not reloadable and any updates require a cloudnet restart.

storesSensitiveData - whether this module stores sensitive data. If true the module configuration will not be dumped to the paste command output.

group - the group id of this module.

name - the name of this module.

version - the version of this module.

main - the main entry-point of this module.

description - the description of this module.

author - the developer and author of this module.

website - the website associated with this module.

dataFolder - the data folder of the module - null results in the default folder structure.

repositories - all defined repositories of this module or null if no repositories are defined.

dependencies - all defined dependencies of this module or null if no dependencies are defined.

minJavaVersionId - the minimum required java version for this module to work.

properties - any extra properties for this module.

All Implemented Interfaces:

Named

public record ModuleConfiguration(boolean runtimeModule, boolean storesSensitiveData, @NonNull String group, @NonNull String name, @NonNull String version, @NonNull String main, @Nullable String description, @Nullable String author, @Nullable String website, @Nullable String dataFolder, @Nullable ModuleRepository[] repositories, @Nullable ModuleDependency[] dependencies, int minJavaVersionId, @Nullable Document properties)
extends Record
implements Named

Represents the module.json file that each module.jar has to contain. The configuration requires the following properties:

• group
• name
• version
• main

All required dependencies of a module should be listed in the dependencies() instead of shading them into the module jar.

If a dependency is not located in maven central the repo of the module dependency needs to be specified.

Since:

4.0

See Also:

• ModuleConfigurationNotFoundException

Field Summary

Fields

Modifier and Type	Field	Description
private final @Nullable String	author	The field for the author record component.
private final @Nullable String	dataFolder	The field for the dataFolder record component.
private final @Nullable ModuleDependency[]	dependencies	The field for the dependencies record component.
private final @Nullable String	description	The field for the description record component.
private final @NonNull String	group	The field for the group record component.
private final @NonNull String	main	The field for the main record component.
private final int	minJavaVersionId	The field for the minJavaVersionId record component.
private final @NonNull String	name	The field for the name record component.
private final @Nullable Document	properties	The field for the properties record component.
private final @Nullable ModuleRepository[]	repositories	The field for the repositories record component.
private final boolean	runtimeModule	The field for the runtimeModule record component.
private final boolean	storesSensitiveData	The field for the storesSensitiveData record component.
private final @NonNull String	version	The field for the version record component.
private final @Nullable String	website	The field for the website record component.

Constructor Summary

Constructors

Constructor

Description

ModuleConfiguration(boolean runtimeModule, boolean storesSensitiveData, @NonNull String group, @NonNull String name, @NonNull String version, @NonNull String main, @Nullable String description, @Nullable String author, @Nullable String website, @Nullable String dataFolder, @Nullable ModuleRepository[] repositories, @Nullable ModuleDependency[] dependencies, int minJavaVersionId, @Nullable Document properties)

Creates an instance of a ModuleConfiguration record class.

Method Summary

Modifier and Type	Method	Description
@Nullable String	author()	Returns the value of the author record component.
boolean	canRunOn(@NonNull JavaVersion javaVersion)	Checks if this module can run on the specified java runtime version.
@Nullable String	dataFolder()	Returns the value of the dataFolder record component.
@NonNull Path	dataFolder(@NonNull Path baseDirectory)	Get the data folder path of this module or a default version of it based on the module's name.
@Nullable ModuleDependency[]	dependencies()	Returns the value of the dependencies record component.
@Nullable String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NonNull String	group()	Returns the value of the group record component.
final int	hashCode()	Returns a hash code value for this object.
@NonNull String	main()	Returns the value of the main record component.
@Nullable JavaVersion	minJavaVersion()	Get the minimum java runtime version this module can run on or null if all runtime versions are supported.
int	minJavaVersionId()	Returns the value of the minJavaVersionId record component.
@NonNull String	name()	Returns the value of the name record component.
@Nullable Document	properties()	Returns the value of the properties record component.
@Nullable ModuleRepository[]	repositories()	Returns the value of the repositories record component.
boolean	runtimeModule()	Returns the value of the runtimeModule record component.
boolean	storesSensitiveData()	Returns the value of the storesSensitiveData record component.
final String	toString()	Returns a string representation of this record class.
@NonNull String	version()	Returns the value of the version record component.
@Nullable String	website()	Returns the value of the website record component.

Methods inherited from class Object

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

Field Details

runtimeModule

private final boolean runtimeModule

The field for the runtimeModule record component.

storesSensitiveData

private final boolean storesSensitiveData

The field for the storesSensitiveData record component.

group

@NonNull
private final @NonNull String group

The field for the group record component.

name

@NonNull
private final @NonNull String name

The field for the name record component.

version

@NonNull
private final @NonNull String version

The field for the version record component.

main

@NonNull
private final @NonNull String main

The field for the main record component.

description

@Nullable
private final @Nullable String description

The field for the description record component.

author

@Nullable
private final @Nullable String author

The field for the author record component.

website

@Nullable
private final @Nullable String website

The field for the website record component.

dataFolder

@Nullable
private final @Nullable String dataFolder

The field for the dataFolder record component.

repositories

@Nullable
private final @Nullable ModuleRepository[] repositories

The field for the repositories record component.

dependencies

@Nullable
private final @Nullable ModuleDependency[] dependencies

The field for the dependencies record component.

minJavaVersionId

private final int minJavaVersionId

The field for the minJavaVersionId record component.

properties

@Nullable
private final @Nullable Document properties

The field for the properties record component.

Constructor Details

ModuleConfiguration

public ModuleConfiguration(boolean runtimeModule,
 boolean storesSensitiveData,
 @NonNull
 @NonNull String group,
 @NonNull
 @NonNull String name,
 @NonNull
 @NonNull String version,
 @NonNull
 @NonNull String main,
 @Nullable
 @Nullable String description,
 @Nullable
 @Nullable String author,
 @Nullable
 @Nullable String website,
 @Nullable
 @Nullable String dataFolder,
 @Nullable
 @Nullable ModuleRepository[] repositories,
 @Nullable
 @Nullable ModuleDependency[] dependencies,
 int minJavaVersionId,
 @Nullable
 @Nullable Document properties)

Creates an instance of a ModuleConfiguration record class.

Parameters:

runtimeModule - the value for the runtimeModule record component

storesSensitiveData - the value for the storesSensitiveData record component

group - the value for the group record component

name - the value for the name record component

version - the value for the version record component

main - the value for the main record component

description - the value for the description record component

author - the value for the author record component

website - the value for the website record component

dataFolder - the value for the dataFolder record component

repositories - the value for the repositories record component

dependencies - the value for the dependencies record component

minJavaVersionId - the value for the minJavaVersionId record component

properties - the value for the properties record component

Method Details

dataFolder

@NonNull
public @NonNull Path dataFolder(@NonNull
 @NonNull Path baseDirectory)

Get the data folder path of this module or a default version of it based on the module's name.

Parameters:

baseDirectory - the base directory of the module provider used to resolve the data folder if no data folder is specified explicitly.

Returns:

the data folder in path form of this module.

minJavaVersion

@Nullable
public @Nullable JavaVersion minJavaVersion()

Get the minimum java runtime version this module can run on or null if all runtime versions are supported.

Returns:

the minimum java runtime version this module can run on.

canRunOn

public boolean canRunOn(@NonNull
 @NonNull JavaVersion javaVersion)

Checks if this module can run on the specified java runtime version.

Parameters:

javaVersion - the runtime version to check.

Returns:

if this module can run on the specified java version.

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.

runtimeModule

public boolean runtimeModule()

Returns the value of the runtimeModule record component.

Returns:

the value of the runtimeModule record component

storesSensitiveData

public boolean storesSensitiveData()

Returns the value of the storesSensitiveData record component.

Returns:

the value of the storesSensitiveData record component

group

@NonNull
public @NonNull String group()

Returns the value of the group record component.

Returns:

the value of the group record component

name

@NonNull
public @NonNull String name()

Returns the value of the name record component.

Specified by:

name in interface Named

Returns:

the value of the name record component

version

@NonNull
public @NonNull String version()

Returns the value of the version record component.

Returns:

the value of the version record component

main

@NonNull
public @NonNull String main()

Returns the value of the main record component.

Returns:

the value of the main record component

description

@Nullable
public @Nullable String description()

Returns the value of the description record component.

Returns:

the value of the description record component

author

@Nullable
public @Nullable String author()

Returns the value of the author record component.

Returns:

the value of the author record component

website

@Nullable
public @Nullable String website()

Returns the value of the website record component.

Returns:

the value of the website record component

dataFolder

@Nullable
public @Nullable String dataFolder()

Returns the value of the dataFolder record component.

Returns:

the value of the dataFolder record component

repositories

@Nullable
public @Nullable ModuleRepository[] repositories()

Returns the value of the repositories record component.

Returns:

the value of the repositories record component

dependencies

@Nullable
public @Nullable ModuleDependency[] dependencies()

Returns the value of the dependencies record component.

Returns:

the value of the dependencies record component

minJavaVersionId

public int minJavaVersionId()

Returns the value of the minJavaVersionId record component.

Returns:

the value of the minJavaVersionId record component

properties

@Nullable
public @Nullable Document properties()

Returns the value of the properties record component.

Returns:

the value of the properties record component