Class HelpBundles

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.help.bundles.HelpBundles

All Implemented Interfaces:

MetaDataProducerOutput, QMetaDataObject, QSupplementalInstanceMetaData, TopLevelMetaDataInterface, Serializable

public class HelpBundles
extends Object
implements QSupplementalInstanceMetaData

Classpath help bundles in registration order, with deterministic precedence.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	HelpBundles.EntryKey	A help row's unique address.
static final record	HelpBundles.WinningEntry	Winning text and its provenance.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
HelpBundles()

Method Summary

Modifier and Type	Method	Description
List<HelpBundle>	getBundles()	Registered bundles in precedence tie order.
String	getName()	Supplemental metadata name.
List<HelpValueProvider>	getValueProviders()	Setting resolvers in registration order.
static HelpBundle	load(String resource, ClassLoader loader)	Load independently of registration; report the resource on every failure.
static HelpBundles	of(QInstance instance)	Obtain the instance's registry.
static void	register(QInstance instance, String resource)	Register using the context class loader, falling back to core's loader.
static void	register(QInstance instance, String resource, ClassLoader loader)	Register with the caller's loader when the host uses isolated class loaders.
Map<HelpBundles.EntryKey,HelpBundles.WinningEntry>	resolveWinningEntries()	Resolve one winner for each key and role.
static void	syncOnStartup(QInstance instance)	Start after loadHelpContent; startup and the caller's session are unaffected.
static void	validateEntry(HelpBundleEntry entry)	Validate the grammar without requiring optional provider metadata to exist.
HelpBundles	withValueProvider(HelpValueProvider provider)	Register a host or qbit setting resolver.

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, validate

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

HelpBundles

public HelpBundles()

Method Details

getName

public String getName()

Supplemental metadata name.

Specified by:

getName in interface TopLevelMetaDataInterface

of

public static HelpBundles of(QInstance instance)

Obtain the instance's registry.

register

public static void register(QInstance instance,
 String resource)

Register using the context class loader, falling back to core's loader.

register

public static void register(QInstance instance,
 String resource,
 ClassLoader loader)

Register with the caller's loader when the host uses isolated class loaders.

load

public static HelpBundle load(String resource,
 ClassLoader loader)

Load independently of registration; report the resource on every failure.

validateEntry

public static void validateEntry(HelpBundleEntry entry)

Validate the grammar without requiring optional provider metadata to exist.

getBundles

public List<HelpBundle> getBundles()

Registered bundles in precedence tie order.

resolveWinningEntries

public Map<HelpBundles.EntryKey,HelpBundles.WinningEntry> resolveWinningEntries()

Resolve one winner for each key and role. Later peers override earlier peers.

withValueProvider

public HelpBundles withValueProvider(HelpValueProvider provider)

Register a host or qbit setting resolver.

getValueProviders

public List<HelpValueProvider> getValueProviders()

Setting resolvers in registration order.

syncOnStartup

public static void syncOnStartup(QInstance instance)

Start after loadHelpContent; startup and the caller's session are unaffected.