Class DeveloperPanelsMetaData

java.lang.Object

com.kingsrook.qqq.backend.core.model.developer.DeveloperPanelsMetaData

All Implemented Interfaces:

MetaDataProducerOutput, QMetaDataObject, QSupplementalInstanceMetaData, TopLevelMetaDataInterface, Serializable

public class DeveloperPanelsMetaData
extends Object
implements QSupplementalInstanceMetaData

Instance-level registry of the DeveloperPanelProviderInterfaces that contribute panels to records' developer views. It is supplemental meta-data, so any module or qbit can add to it; it is not sent to frontends (the panels themselves are, by the record developer panels endpoint).

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
DeveloperPanelsMetaData()

Method Summary

Modifier and Type	Method	Description
String	getName()
List<QCodeReference>	getProviders()	Getter for providers
static DeveloperPanelsMetaData	of(QInstance qInstance)	Get the instance's registry, or null when nothing registered a provider.
static DeveloperPanelsMetaData	ofOrWithNew(QInstance qInstance)	Get the instance's registry, adding an empty one if it has none.
void	setProviders(List<QCodeReference> providers)	Setter for providers
void	validate(QInstance qInstance, QInstanceValidator validator)	Every provider must name a class that implements the provider interface.
DeveloperPanelsMetaData	withProvider(QCodeReference provider)	Register a provider class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.backend.core.model.metadata.QSupplementalInstanceMetaData

addSelfToInstance, enrich

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

DeveloperPanelsMetaData

public DeveloperPanelsMetaData()

Method Details

of

public static DeveloperPanelsMetaData of(QInstance qInstance)

Get the instance's registry, or null when nothing registered a provider.

ofOrWithNew

public static DeveloperPanelsMetaData ofOrWithNew(QInstance qInstance)

Get the instance's registry, adding an empty one if it has none.

getName

public String getName()

Specified by:

getName in interface TopLevelMetaDataInterface

withProvider

public DeveloperPanelsMetaData withProvider(QCodeReference provider)

Register a provider class. Registering the same class again is a no-op, so modules may register idempotently.

getProviders

public List<QCodeReference> getProviders()

Getter for providers

setProviders

public void setProviders(List<QCodeReference> providers)

Setter for providers

validate

public void validate(QInstance qInstance,
 QInstanceValidator validator)

Every provider must name a class that implements the provider interface.

Specified by:

validate in interface QSupplementalInstanceMetaData