Package ovh.mythmc.gestalt.features

Class GestaltFeature

java.lang.Object

ovh.mythmc.gestalt.features.GestaltFeature

public class GestaltFeature
extends Object

A descriptor that bundles a Feature-annotated class with optional custom constructor parameters used during instantiation.

Use builder() to create instances via the fluent GestaltFeature.GestaltFeatureBuilder. Pass the built instance to Gestalt.register(GestaltFeature) to register the feature with its associated constructor parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GestaltFeature.GestaltFeatureBuilder	Builder for GestaltFeature.

Method Summary

Modifier and Type	Method	Description
static GestaltFeature.GestaltFeatureBuilder	builder()	Returns a new GestaltFeature.GestaltFeatureBuilder for creating a GestaltFeature.
FeatureConstructorParams	getConstructorParams()	Returns the optional constructor parameters to use when instantiating the feature class, or null if the feature uses a no-arg constructor.
Class<?>	getFeatureClass()	Returns the feature class described by this descriptor.

Methods inherited from class java.lang.Object

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

Method Details

getFeatureClass

public Class<?> getFeatureClass()

Returns the feature class described by this descriptor.

Returns:

the feature class

getConstructorParams

public FeatureConstructorParams getConstructorParams()

Returns the optional constructor parameters to use when instantiating the feature class, or null if the feature uses a no-arg constructor.

Returns:

the constructor parameters, or null

builder

public static GestaltFeature.GestaltFeatureBuilder builder()

Returns a new GestaltFeature.GestaltFeatureBuilder for creating a GestaltFeature.

Returns:

a new builder