Record Class ProcessConfiguration

java.lang.Object

java.lang.Record

eu.cloudnetservice.driver.service.ProcessConfiguration

Record Components:

environment - the environment of the task / service this configuration belongs to.

maxHeapMemorySize - the maximum amount of heap (in MB) a service is allowed to use.

jvmOptions - the jvm options to apply to the process, for example the garbage collector.

processParameters - the process parameters to apply after the actual command line, for example --dev.

environmentVariables - the environment variables to apply to the service environment.

All Implemented Interfaces:

Cloneable

public record ProcessConfiguration(@NonNull String environment, int maxHeapMemorySize, @Unmodifiable @NonNull List<String> jvmOptions, @Unmodifiable @NonNull List<String> processParameters, @Unmodifiable @NonNull Map<String,String> environmentVariables)
extends Record
implements Cloneable

Holds the most common options to configure any process started and managed by CloudNet.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProcessConfiguration.Builder	Represents a builder for a process configuration.

Field Summary

Fields

Modifier and Type	Field	Description
private final @NonNull String	environment	The field for the environment record component.
private final @Unmodifiable @NonNull Map<String,String>	environmentVariables	The field for the environmentVariables record component.
private final @Unmodifiable @NonNull List<String>	jvmOptions	The field for the jvmOptions record component.
private final int	maxHeapMemorySize	The field for the maxHeapMemorySize record component.
private final @Unmodifiable @NonNull List<String>	processParameters	The field for the processParameters record component.

Constructor Summary

Constructors

Constructor	Description
ProcessConfiguration(@NonNull String environment, int maxHeapMemorySize, @Unmodifiable @NonNull List<String> jvmOptions, @Unmodifiable @NonNull List<String> processParameters, @Unmodifiable @NonNull Map<String,String> environmentVariables)	Creates an instance of a ProcessConfiguration record class.

Method Summary

Modifier and Type	Method	Description
static @NonNull ProcessConfiguration.Builder	builder()	Constructs a new builder for a process configuration.
static @NonNull ProcessConfiguration.Builder	builder(@NonNull ProcessConfiguration configuration)	Constructs a new builder for a process configuration copying the properties from the given configuration into the builder.
ProcessConfiguration	clone()
@NonNull String	environment()	Returns the value of the environment record component.
@Unmodifiable @NonNull Map<String,String>	environmentVariables()	Returns the value of the environmentVariables record component.
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.
@Unmodifiable @NonNull List<String>	jvmOptions()	Returns the value of the jvmOptions record component.
int	maxHeapMemorySize()	Returns the value of the maxHeapMemorySize record component.
@Unmodifiable @NonNull List<String>	processParameters()	Returns the value of the processParameters record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

environment

@NonNull
private final @NonNull String environment

The field for the environment record component.

maxHeapMemorySize

private final int maxHeapMemorySize

The field for the maxHeapMemorySize record component.

jvmOptions

@NonNull
private final @Unmodifiable @NonNull List<String> jvmOptions

The field for the jvmOptions record component.

processParameters

@NonNull
private final @Unmodifiable @NonNull List<String> processParameters

The field for the processParameters record component.

environmentVariables

@NonNull
private final @Unmodifiable @NonNull Map<String,String> environmentVariables

The field for the environmentVariables record component.

Constructor Details

ProcessConfiguration

public ProcessConfiguration(@NonNull
 @NonNull String environment,
 int maxHeapMemorySize,
 @NonNull
 @Unmodifiable @NonNull List<String> jvmOptions,
 @NonNull
 @Unmodifiable @NonNull List<String> processParameters,
 @NonNull
 @Unmodifiable @NonNull Map<String,String> environmentVariables)

Creates an instance of a ProcessConfiguration record class.

Parameters:

environment - the value for the environment record component

maxHeapMemorySize - the value for the maxHeapMemorySize record component

jvmOptions - the value for the jvmOptions record component

processParameters - the value for the processParameters record component

environmentVariables - the value for the environmentVariables record component

Method Details

builder

@NonNull
public static @NonNull ProcessConfiguration.Builder builder()

Constructs a new builder for a process configuration.

Returns:

a new builder for a process configuration.

builder

@NonNull
public static @NonNull ProcessConfiguration.Builder builder(@NonNull
 @NonNull ProcessConfiguration configuration)

Constructs a new builder for a process configuration copying the properties from the given configuration into the builder. This means that calling build after creating the builder using this method will result in a new process configuration which is equal to the given configuration.

Parameters:

configuration - the configuration to copy the properties of.

Returns:

a new builder for a process configuration.

Throws:

NullPointerException - if the given process configuration is null.

clone

public ProcessConfiguration clone()

Overrides:

clone in class Object

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.

environment

@NonNull
public @NonNull String environment()

Returns the value of the environment record component.

Returns:

the value of the environment record component

maxHeapMemorySize

public int maxHeapMemorySize()

Returns the value of the maxHeapMemorySize record component.

Returns:

the value of the maxHeapMemorySize record component

jvmOptions

@NonNull
public @Unmodifiable @NonNull List<String> jvmOptions()

Returns the value of the jvmOptions record component.

Returns:

the value of the jvmOptions record component

processParameters

@NonNull
public @Unmodifiable @NonNull List<String> processParameters()

Returns the value of the processParameters record component.

Returns:

the value of the processParameters record component

environmentVariables

@NonNull
public @Unmodifiable @NonNull Map<String,String> environmentVariables()

Returns the value of the environmentVariables record component.

Returns:

the value of the environmentVariables record component