Record Class PluginMetadata

java.lang.Object

java.lang.Record

me.pauleff.converter.api.PluginMetadata

Record Components:

id - a non-blank unique plugin identifier

displayName - a human-readable name shown in logs or UI

description - a short description of what the plugin does

priority - the execution priority; lower values run earlier after clamping

public record PluginMetadata(String id, String displayName, String description, int priority)
extends Record

Holds identifying and scheduling information for a MOOCPlugin.

Priority is clamped to the inclusive range MIN_PRIORITY–MAX_PRIORITY when the record is constructed. Factory methods supply a default priority when omitted.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_PRIORITY
static final int	MAX_PRIORITY
static final int	MIN_PRIORITY

Constructor Summary

Constructors

Constructor	Description
PluginMetadata(String id, String displayName, String description, int priority)	Validates non-null record components, rejects a blank id, and clamps priority into the allowed range.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
String	displayName()	Returns the value of the displayName 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.
String	id()	Returns the value of the id record component.
static PluginMetadata	of(String id, String displayName, String description)	Creates metadata with DEFAULT_PRIORITY.
static PluginMetadata	of(String id, String displayName, String description, int priority)	Creates metadata with an explicit priority (clamped on construction).
int	priority()	Returns the value of the priority record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

MIN_PRIORITY

public static final int MIN_PRIORITY

See Also:

• Constant Field Values

MAX_PRIORITY

public static final int MAX_PRIORITY

See Also:

• Constant Field Values

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

See Also:

• Constant Field Values

Constructor Details

PluginMetadata

public PluginMetadata(String id,
 String displayName,
 String description,
 int priority)

Validates non-null record components, rejects a blank id, and clamps priority into the allowed range.

Throws:

NullPointerException - if id, displayName, or description is null

IllegalArgumentException - if id is blank

Method Details

of

public static PluginMetadata of(String id,
 String displayName,
 String description)

Creates metadata with DEFAULT_PRIORITY.

Parameters:

id - a non-blank unique plugin identifier

displayName - a human-readable name shown in logs or UI

description - a short description of what the plugin does

Returns:

a new PluginMetadata instance

of

public static PluginMetadata of(String id,
 String displayName,
 String description,
 int priority)

Creates metadata with an explicit priority (clamped on construction).

Parameters:

id - a non-blank unique plugin identifier

displayName - a human-readable name shown in logs or UI

description - a short description of what the plugin does

priority - the desired execution priority before clamping

Returns:

a new PluginMetadata instance

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.

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

displayName

public String displayName()

Returns the value of the displayName record component.

Returns:

the value of the displayName record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

priority

public int priority()

Returns the value of the priority record component.

Returns:

the value of the priority record component