Package io.jenkins.plugins.casc

Interface ConfiguratorRegistry

All Known Implementing Classes:

ConfigurationContext, DefaultConfiguratorRegistry

public interface ConfiguratorRegistry

A Registry to allow Configurators retrieval.

Author:

Nicolas De Loof

Method Summary

Modifier and Type	Method	Description
static ConfiguratorRegistry	get()	Retrieve default implementation from Jenkins
<T> Configurator<T>	lookup(Type type)	Retrieve a Configurator for target type.
<T> Configurator<T>	lookupOrFail(Type type)	null-safe flavour of lookup(Type).
RootElementConfigurator	lookupRootElement(String name)	Retrieve a RootElementConfigurator by it's yaml element (key) name.

Method Details

lookupRootElement

@CheckForNull
RootElementConfigurator lookupRootElement(String name)

Retrieve a RootElementConfigurator by it's yaml element (key) name.

Parameters:

name -

Returns:

null if we don't know any RootElementConfigurator for requested name

lookup

@CheckForNull
<T> Configurator<T> lookup(Type type)

Retrieve a Configurator for target type.

Parameters:

type -

Returns:

null if we don't know any RootElementConfigurator for requested type

lookupOrFail

@NonNull
<T> Configurator<T> lookupOrFail(Type type)
                          throws ConfiguratorException

null-safe flavour of lookup(Type).

Parameters:

type -

Throws:

ConfiguratorException - if we don't know any RootElementConfigurator for requested type

get

static ConfiguratorRegistry get()

Retrieve default implementation from Jenkins