Package io.quarkus.devui.deployment

Class BuildTimeContentProcessor

java.lang.Object

io.quarkus.devui.deployment.BuildTimeContentProcessor

public class BuildTimeContentProcessor
extends Object

This creates static content that is used in dev UI. For example the index.html and any other data (json) available on build time

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	BuildTimeContentProcessor.Color	This represents a HSLA color see https://www.w3schools.com/html/html_colors_hsl.asp

Field Summary

Fields

Modifier and Type	Field	Description
(package private) org.eclipse.microprofile.config.Config	config

Constructor Summary

Constructors

Constructor	Description
BuildTimeContentProcessor()

Method Summary

Modifier and Type	Method	Description
(package private) void	createBuildTimeConstJsTemplate(io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem curateOutcomeBuildItem, NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem, List<BuildTimeConstBuildItem> buildTimeConstBuildItems, io.quarkus.deployment.annotations.BuildProducer<QuteTemplateBuildItem> quteTemplateProducer, io.quarkus.deployment.annotations.BuildProducer<InternalImportMapBuildItem> internalImportMapProducer)	Here we find all build time data and make then available via a const js components can import the const with "import {constName} from '{ext}-data';"
(package private) void	createBuildTimeData(io.quarkus.deployment.annotations.BuildProducer<BuildTimeConstBuildItem> buildTimeConstProducer, io.quarkus.deployment.annotations.BuildProducer<ThemeVarsBuildItem> themeVarsProducer, List<InternalPageBuildItem> internalPages, ExtensionsBuildItem extensionsBuildItem, NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem)	Creates json data that is available in Javascript
(package private) QuteTemplateBuildItem	createIndexHtmlTemplate(MvnpmBuildItem mvnpmBuildItem, ThemeVarsBuildItem themeVarsBuildItem, NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem, List<InternalImportMapBuildItem> internalImportMapBuildItems)	Here we create index.html We aggregate all import maps into one This includes import maps from 3rd party libs from mvnpm.org and internal ones defined above
(package private) InternalImportMapBuildItem	createKnownInternalImportMap(NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem)	Here we create references to internal dev ui files so that they can be imported by ref.
(package private) void	gatherMvnpmJars(io.quarkus.deployment.annotations.BuildProducer<MvnpmBuildItem> mvnpmProducer, io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem curateOutcomeBuildItem)	Here we find all the mvnpm jars
(package private) void	loadAllBuildTimeTemplates(io.quarkus.deployment.annotations.BuildProducer<StaticContentBuildItem> buildTimeContentProducer, List<QuteTemplateBuildItem> templates)
(package private) void	mapPageBuildTimeData(List<CardPageBuildItem> pageBuildItems, io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem curateOutcomeBuildItem, io.quarkus.deployment.annotations.BuildProducer<BuildTimeConstBuildItem> buildTimeConstProducer)	Here we map all the pages (as defined by the extensions) build time data

Methods inherited from class java.lang.Object

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

Field Detail

config

final org.eclipse.microprofile.config.Config config

Constructor Detail

BuildTimeContentProcessor

public BuildTimeContentProcessor()

Method Detail

createKnownInternalImportMap

InternalImportMapBuildItem createKnownInternalImportMap(NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem)

Here we create references to internal dev ui files so that they can be imported by ref. This will be merged into the final importmap

mapPageBuildTimeData

void mapPageBuildTimeData(List<CardPageBuildItem> pageBuildItems,
                          io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem curateOutcomeBuildItem,
                          io.quarkus.deployment.annotations.BuildProducer<BuildTimeConstBuildItem> buildTimeConstProducer)

Here we map all the pages (as defined by the extensions) build time data

Parameters:

pageBuildItems -

buildTimeConstProducer -

createBuildTimeConstJsTemplate

void createBuildTimeConstJsTemplate(io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem curateOutcomeBuildItem,
                                    NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem,
                                    List<BuildTimeConstBuildItem> buildTimeConstBuildItems,
                                    io.quarkus.deployment.annotations.BuildProducer<QuteTemplateBuildItem> quteTemplateProducer,
                                    io.quarkus.deployment.annotations.BuildProducer<InternalImportMapBuildItem> internalImportMapProducer)

Here we find all build time data and make then available via a const js components can import the const with "import {constName} from '{ext}-data';"

Parameters:

pageBuildItems -

quteTemplateProducer -

internalImportMapProducer -

gatherMvnpmJars

void gatherMvnpmJars(io.quarkus.deployment.annotations.BuildProducer<MvnpmBuildItem> mvnpmProducer,
                     io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem curateOutcomeBuildItem)

Here we find all the mvnpm jars

createIndexHtmlTemplate

QuteTemplateBuildItem createIndexHtmlTemplate(MvnpmBuildItem mvnpmBuildItem,
                                              ThemeVarsBuildItem themeVarsBuildItem,
                                              NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem,
                                              List<InternalImportMapBuildItem> internalImportMapBuildItems)

Here we create index.html We aggregate all import maps into one This includes import maps from 3rd party libs from mvnpm.org and internal ones defined above

Returns:

The QuteTemplate Build item that will create the end result

loadAllBuildTimeTemplates

void loadAllBuildTimeTemplates(io.quarkus.deployment.annotations.BuildProducer<StaticContentBuildItem> buildTimeContentProducer,
                               List<QuteTemplateBuildItem> templates)

createBuildTimeData

void createBuildTimeData(io.quarkus.deployment.annotations.BuildProducer<BuildTimeConstBuildItem> buildTimeConstProducer,
                         io.quarkus.deployment.annotations.BuildProducer<ThemeVarsBuildItem> themeVarsProducer,
                         List<InternalPageBuildItem> internalPages,
                         ExtensionsBuildItem extensionsBuildItem,
                         NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem)

Creates json data that is available in Javascript