Package io.artificial.enchantments.api.scaling

Class ScalingAlgorithmMetadata

java.lang.Object

io.artificial.enchantments.api.scaling.ScalingAlgorithmMetadata

public final class ScalingAlgorithmMetadata
extends Object

Immutable metadata for a registered scaling algorithm.

This class provides read-only information about a scaling algorithm including its name, description, and parameter requirements.

Since:

0.2.0

Constructor Summary

Constructors

Constructor	Description
ScalingAlgorithmMetadata(@NotNull String name, @NotNull String description, int parameterCount, @NotNull String[] parameterNames, boolean builtIn)	Creates metadata for a scaling algorithm.

Method Summary

Modifier and Type	Method	Description
@NotNull String	getDescription()	Gets the algorithm description.
@NotNull String	getName()	Gets the algorithm name.
int	getParameterCount()	Gets the number of parameters required.
@NotNull String[]	getParameterNames()	Gets the parameter names.
boolean	isBuiltIn()	Checks if this is a built-in algorithm.
@NotNull String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ScalingAlgorithmMetadata

public ScalingAlgorithmMetadata(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull String description,
 int parameterCount,
 @NotNull
 @NotNull String[] parameterNames,
 boolean builtIn)

Creates metadata for a scaling algorithm.

Parameters:

name - the algorithm name

description - the algorithm description

parameterCount - the number of parameters required

parameterNames - the names of parameters

builtIn - true if this is a built-in algorithm

Method Details

getName

@NotNull
public @NotNull String getName()

Gets the algorithm name.

Returns:

the name

getDescription

@NotNull
public @NotNull String getDescription()

Gets the algorithm description.

Returns:

the description

getParameterCount

public int getParameterCount()

Gets the number of parameters required.

Returns:

the parameter count

getParameterNames

@NotNull
public @NotNull String[] getParameterNames()

Gets the parameter names.

Returns:

a copy of the parameter names array

isBuiltIn

public boolean isBuiltIn()

Checks if this is a built-in algorithm.

Returns:

true if built-in

toString

@NotNull
public @NotNull String toString()

Overrides:

toString in class Object