Package com.inductiveautomation.ignition.gateway.config

Class ReferenceFinderBuilder<C>

java.lang.Object

com.inductiveautomation.ignition.gateway.config.ReferenceFinderBuilder<C>

Type Parameters:

C - The type of the configuration object. This may be the config type "R" that matches a ResourceTypeMeta, or it may be the profile type "P" of an ExtensionPointResourceTypeMeta, or the settings object of an ExtensionPoint, depending on the context of where this reference finder is being used.

public class ReferenceFinderBuilder<C>
extends Object

Helps build a ReferenceFinder for a specific property and a known target resource type.

See Also:

• DefaultResourceTypeMeta.Builder#referenceProperty(String, Consumer)
• ExtensionPointResourceTypeMeta.Builder#referenceProperty(String, Consumer)
• AbstractExtensionPoint.addReferenceProperty(String, Consumer)

Constructor Summary

Constructors

Constructor	Description
ReferenceFinderBuilder(String propertyName)

Method Summary

Modifier and Type	Method	Description
ReferenceFinderBuilder<C>	match(BiPredicate<C,String> referenceMatch)
ReferenceFinderBuilder<C>	onUpdate(BiFunction<C,String,C> updateConfig)
ReferenceFinderBuilder<C>	targetType(ResourceType targetResourceType)

Methods inherited from class java.lang.Object

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

Constructor Details

ReferenceFinderBuilder

public ReferenceFinderBuilder(@Nonnull
 String propertyName)

Method Details

targetType

public ReferenceFinderBuilder<C> targetType(ResourceType targetResourceType)

Parameters:

targetResourceType - The resource type of the target resource that this reference finder is looking for.

match

public ReferenceFinderBuilder<C> match(BiPredicate<C,String> referenceMatch)

Parameters:

referenceMatch - Predicate that finds matching references to a target. The type of the target will be constrained to the type specified by targetType(ResourceType).

onUpdate

public ReferenceFinderBuilder<C> onUpdate(BiFunction<C,String,C> updateConfig)

Parameters:

updateConfig - A callback that returns a new copy of the configuration object with the reference updated.