Package jetbrains.buildServer.serverSide.statistics

Interface ValueProviderRegistry

All Superinterfaces:

ValueProviderResolver

All Known Implementing Classes:

ValueProviderRegistry.Adapter, ValueProviderRegistryImpl

public interface ValueProviderRegistry
extends ValueProviderResolver

ValueProvider registry

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ValueProviderRegistry.Adapter

Method Summary

Modifier and Type	Method	Description
void	addUnknownKeyHandler(ValueProviderResolver valueTypeResolver)	Register a ValueProviderResolver that will be used when getValueProvider(String) will be called with a key that was not registered neither by registerValueProvider(ValueProvider) nor by registerAlias(ValueProvider, String).
ValueProvider	getValueProvider(String key)	Returns registered ValueProvider
Collection<ValueProvider>	getValueProviders()
ValueProvider	registerAlias(ValueProvider valueProvider, String key)
ValueProvider	registerorFindValueProvider(ValueProvider valueProvider)	Registers a value provider, if there is no value provider with given valueProvider.getKey
void	registerValueProvider(ValueProvider valueProvider)	Registers a value provider
void	unregisterValueProvider(ValueProvider valueProvider)	Unregisters a value provider.

Method Detail

getValueProvider

@Nullable
ValueProvider getValueProvider(@NotNull
                               String key)

Returns registered ValueProvider

Specified by:

getValueProvider in interface ValueProviderResolver

Parameters:

key - to lookup

Returns:

found registered ValueType

See Also:

ValueProvider.getKey()

registerValueProvider

void registerValueProvider(@NotNull
                           ValueProvider valueProvider)

Registers a value provider

Parameters:

valueProvider - metric value provider

Throws:

IllegalArgumentException - if trying register a value provider with the same key

registerorFindValueProvider

ValueProvider registerorFindValueProvider(@NotNull
                                          ValueProvider valueProvider)

Registers a value provider, if there is no value provider with given valueProvider.getKey

Parameters:

valueProvider - value provider

Returns:

registered value provider or existing, previously registered value provider with given key

registerAlias

ValueProvider registerAlias(@NotNull
                            ValueProvider valueProvider,
                            @NotNull
                            String key)

unregisterValueProvider

void unregisterValueProvider(@NotNull
                             ValueProvider valueProvider)

Unregisters a value provider. If not registered, does nothing

Parameters:

valueProvider - to unregister

getValueProviders

@NotNull
Collection<ValueProvider> getValueProviders()

Returns:

collection of all registered value providers in the system

addUnknownKeyHandler

void addUnknownKeyHandler(@NotNull
                          ValueProviderResolver valueTypeResolver)

Register a ValueProviderResolver that will be used when getValueProvider(String) will be called with a key that was not registered neither by registerValueProvider(ValueProvider) nor by registerAlias(ValueProvider, String). ValueProviders provided by ValueProviderResolver will not be cached or registered and will not appear in getValueProviders(). Registered ValueProviderResolver will be called in the order they were added until any returns a ValueProvider. In order to provide default format and description for a key ValueProviderResolver must return a ValueProvider implementing at least class (e.g. SimpleBuildMetricVT).

Parameters:

valueTypeResolver - ValueProviderResolver to register