Package com.inductiveautomation.ignition.gateway.model.entity

Class EntityBuilder

java.lang.Object

com.inductiveautomation.ignition.gateway.model.entity.EntityBuilder

public class EntityBuilder
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EntityBuilder.DescriptionComponentBuilder
static class	EntityBuilder.DiagnosticComponentBuilder
static class	EntityBuilder.NavigationComponentBuilder

Constructor Summary

Constructors

Constructor	Description
EntityBuilder(String name)

Method Summary

Modifier and Type	Method	Description
Entity	build()
<C> EntityBuilder	children(IntSupplier total, Supplier<Stream<C>> childrenSupplier, Function<C,String> toString, BiConsumer<C,EntityBuilder> childEntityBuilder)
EntityBuilder	children(IntSupplier total, Supplier<Stream<Entity>> childrenSupplier)
EntityBuilder	children(List<Entity> children)
EntityBuilder	description(String description)
EntityBuilder	description(Consumer<EntityBuilder.DescriptionComponentBuilder> descriptionBuilder)
EntityBuilder	diagnostics(com.codahale.metrics.MetricRegistry metricRegistry, com.codahale.metrics.health.HealthCheckRegistry healthCheckRegistry, Consumer<EntityBuilder.DiagnosticComponentBuilder> diagnosticsBuilder)
EntityBuilder	diagnostics(DiagnosticComponent diagnosticComponent)
EntityBuilder	diagnostics(GatewayContext context, Consumer<EntityBuilder.DiagnosticComponentBuilder> diagnosticsBuilder)	Adds a DiagnosticComponent to this entity.
EntityBuilder	diagnostics(Consumer<EntityBuilder.DiagnosticComponentBuilder> diagnosticsBuilder)	Adds a DiagnosticComponent to this entity.
EntityBuilder	enablement(BooleanSupplier isEnabled)	Adds an immutable EnablementComponent to this entity with the given supplier of enabled state.
EntityBuilder	enablement(BooleanSupplier isEnabled, BiFunction<Boolean,String,CompletableFuture<Void>> setEnabled)	Adds a mutable EnablementComponent with the given state getter and setter.
EntityBuilder	iconUrl(String iconUrl)
EntityBuilder	lastModified(Date lastModified, String lastModifiedBy)
EntityBuilder	navigation(String sectionLabel, Consumer<EntityBuilder.NavigationComponentBuilder> navigationBuilder)	Adds a NavigationComponent to this entity.

Methods inherited from class java.lang.Object

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

Constructor Details

EntityBuilder

public EntityBuilder(String name)

Method Details

navigation

public EntityBuilder navigation(String sectionLabel,
 Consumer<EntityBuilder.NavigationComponentBuilder> navigationBuilder)

Adds a NavigationComponent to this entity.

Parameters:

sectionLabel - The section label that this entity lives under. See the static constants in Section for well-known section labels.

navigationBuilder - Used to further customize the NavigationComponent for this entity.

enablement

public EntityBuilder enablement(BooleanSupplier isEnabled)

Adds an immutable EnablementComponent to this entity with the given supplier of enabled state.

Parameters:

isEnabled - Provides view into enabled state

enablement

public EntityBuilder enablement(BooleanSupplier isEnabled,
 BiFunction<Boolean,String,CompletableFuture<Void>> setEnabled)

Adds a mutable EnablementComponent with the given state getter and setter.

Parameters:

isEnabled - Provides view into enabled state

setEnabled - Used to change the enabled state (enable or disable). This method should return a future that completes when the operation is complete.

description

public EntityBuilder description(String description)

description

public EntityBuilder description(Consumer<EntityBuilder.DescriptionComponentBuilder> descriptionBuilder)

iconUrl

public EntityBuilder iconUrl(String iconUrl)

lastModified

public EntityBuilder lastModified(Date lastModified,
 String lastModifiedBy)

children

public EntityBuilder children(List<Entity> children)

children

public <C> EntityBuilder children(IntSupplier total,
 Supplier<Stream<C>> childrenSupplier,
 Function<C,String> toString,
 BiConsumer<C,EntityBuilder> childEntityBuilder)

children

public EntityBuilder children(IntSupplier total,
 Supplier<Stream<Entity>> childrenSupplier)

diagnostics

public EntityBuilder diagnostics(@Nonnull
 Consumer<EntityBuilder.DiagnosticComponentBuilder> diagnosticsBuilder)

Adds a DiagnosticComponent to this entity. Use this method only if you add on-demand metrics and healthchecks that don't use the registries.

diagnostics

public EntityBuilder diagnostics(@Nonnull
 GatewayContext context,
 @Nonnull
 Consumer<EntityBuilder.DiagnosticComponentBuilder> diagnosticsBuilder)

Adds a DiagnosticComponent to this entity. Use this method if you want to add metrics and healthchecks that are registered with the gateway-wide registries.

diagnostics

public EntityBuilder diagnostics(@Nullable
 com.codahale.metrics.MetricRegistry metricRegistry,
 @Nullable
 com.codahale.metrics.health.HealthCheckRegistry healthCheckRegistry,
 @Nonnull
 Consumer<EntityBuilder.DiagnosticComponentBuilder> diagnosticsBuilder)

diagnostics

public EntityBuilder diagnostics(DiagnosticComponent diagnosticComponent)

build

public Entity build()