Package com.inductiveautomation.perspective.gateway.api

Interface ComponentModelDelegateRegistry

All Known Implementing Classes:

ComponentModelDelegateRegistryImpl

public interface ComponentModelDelegateRegistry

A Registry for ComponentModelDelegateFactories

Method Summary

Modifier and Type	Method	Description
Optional<ComponentModelDelegateFactory>	find(String typeId)	Fetch the ComponentModelDelegateFactory registered with the given typeId
static ComponentModelDelegateRegistry	get(GatewayContext context)	Static accessor for the ComponentModelDelegateRegistry instance contained by the provided context
void	register(String componentTypeId, ComponentModelDelegateFactory factory)	Register a ComponentModelDelegateFactory with its type ID
void	remove(String componentTypeId)	Removes the delegate registered with the id from the set of those registered.

Method Details

get

static ComponentModelDelegateRegistry get(GatewayContext context)

Static accessor for the ComponentModelDelegateRegistry instance contained by the provided context

Parameters:

context - The current running CommonContext

Returns:

The ComponentModelDelegateRegistry instance

register

void register(String componentTypeId,
 ComponentModelDelegateFactory factory)

Register a ComponentModelDelegateFactory with its type ID

Parameters:

componentTypeId - The component type ID associated with the factory

factory - The factory to register

find

Optional<ComponentModelDelegateFactory> find(@Nonnull
 String typeId)

Fetch the ComponentModelDelegateFactory registered with the given typeId

Parameters:

typeId - The component type ID

Returns:

An Optional containing the ComponentModelDelegateFactory registered with the given typeId or an empty Optional if no such factory is registered with the given type ID

remove

void remove(String componentTypeId)

Removes the delegate registered with the id from the set of those registered.

Parameters:

componentTypeId - the id of the component type whose delegate should be removed from the registry.